6d40302d89
This reverts commit d8ac55e3e5.
Change-Id: Ib7cf67d5d0b7780dfde9453cdddb8f11ca5d3a6a
Reviewed-on: https://gerrit.libreoffice.org/c/core/+/90542
Tested-by: Jenkins
Reviewed-by: Noel Grandin <noel.grandin@collabora.co.uk>
145 lines
7.4 KiB
C++
145 lines
7.4 KiB
C++
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
|
|
/*
|
|
* This file is part of the LibreOffice project.
|
|
*
|
|
* This Source Code Form is subject to the terms of the Mozilla Public
|
|
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
|
*
|
|
* This file incorporates work covered by the following license notice:
|
|
*
|
|
* Licensed to the Apache Software Foundation (ASF) under one or more
|
|
* contributor license agreements. See the NOTICE file distributed
|
|
* with this work for additional information regarding copyright
|
|
* ownership. The ASF licenses this file to you under the Apache
|
|
* License, Version 2.0 (the "License"); you may not use this file
|
|
* except in compliance with the License. You may obtain a copy of
|
|
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
|
|
*/
|
|
|
|
#ifndef INCLUDED_UNOTOOLS_TEMPFILE_HXX
|
|
#define INCLUDED_UNOTOOLS_TEMPFILE_HXX
|
|
|
|
#include <unotools/unotoolsdllapi.h>
|
|
#include <tools/stream.hxx>
|
|
#include <memory>
|
|
|
|
namespace utl
|
|
{
|
|
|
|
/**
|
|
The class TempFile gives access to temporary files in the local file system. Sometimes they are needed because a 3rd party
|
|
code has a file name based interface, or some file access has to be done locally without transferring tons of bytes to or
|
|
from a remote system.
|
|
Creating a UCB content on a TempFile is only possible if a UCP for the local file system is present.
|
|
TempFiles can always be accessed by SvFileStreams or Sot/SvStorages using the "physical" file name ( not the URL, because
|
|
this may be a non-file URL, see below ), but if a UCB content can be created, it is also possible to take the URL and use
|
|
the UCB helper classes for streams. For convenience use UcbStreamHelper.
|
|
A Tempfile always has a "physical" file name ( a file name in the local computers host notation ) but it has a
|
|
"UCB compatible" URL only if a UCP for the local file system exists. This URL may have its own URL scheme
|
|
( not necessarily "file://" ! ). The TempFile class methods take this into account, but other simple conversions like
|
|
the osl functions do not.
|
|
So it is a potential error to convert between the filename and the URL of a TempFile object using functions or methods
|
|
outside this class.
|
|
*/
|
|
|
|
class UNOTOOLS_DLLPUBLIC TempFile
|
|
{
|
|
OUString aName;
|
|
std::unique_ptr<SvStream>
|
|
pStream;
|
|
bool bIsDirectory;
|
|
bool bKillingFileEnabled;
|
|
|
|
public:
|
|
/**
|
|
Create a temporary file or directory, in the default tempfile folder or if possible in a given folder.
|
|
This given folder ( the "parent" parameter ( if not NULL ) ) must be a "UCB compatible" URL.
|
|
The temporary object is created in the local file system, even if there is no UCB that can access it.
|
|
If the given folder is part of the local file system, the TempFile is created in this folder.
|
|
*/
|
|
TempFile( const OUString* pParent=nullptr, bool bDirectory=false );
|
|
|
|
/**
|
|
Same as above; additionally the name starts with some given characters followed by a counter ( example:
|
|
rLeadingChars="abc" means "abc0","abc1" and so on, depending on existing files in the folder ).
|
|
The extension string may be f.e. ".txt" or "", if no extension string is given, ".tmp" is used
|
|
@param _bStartWithZero If set to false names will be generated like "abc","abc0","abc1"
|
|
@param bCreateParentDirs If rLeadingChars contains a slash, this will create the required
|
|
parent directories.
|
|
*/
|
|
TempFile( const OUString& rLeadingChars, bool _bStartWithZero=true, const OUString* pExtension=nullptr,
|
|
const OUString* pParent=nullptr, bool bCreateParentDirs=false );
|
|
|
|
TempFile(TempFile && other) noexcept;
|
|
|
|
/**
|
|
TempFile will be removed from disk in dtor if EnableKillingFile(true) was called before.
|
|
Temporary directories will be removed recursively in that case.
|
|
*/
|
|
~TempFile();
|
|
|
|
/**
|
|
Returns sal_True if it has a valid file name.
|
|
*/
|
|
bool IsValid() const;
|
|
|
|
/**
|
|
Returns the URL of the tempfile object.
|
|
If you want to have the system path file name, use the GetFileName() method of this object
|
|
*/
|
|
OUString const & GetURL() const;
|
|
|
|
/**
|
|
Returns the system path name of the tempfile in host notation
|
|
If you want to have the URL, use the GetURL() method of this object.
|
|
*/
|
|
OUString GetFileName() const;
|
|
|
|
/**
|
|
Returns a stream to the tempfiles data; the stream is owned by the tempfile object, so you have to keep this
|
|
alive as long as you want to use the stream. If the TempFile object is destroyed, it also destroys the
|
|
stream object, the underlying file is only deleted if EnableKillingFile(true) has been called before!
|
|
*/
|
|
SvStream* GetStream( StreamMode eMode );
|
|
|
|
/**
|
|
Let the TempFile object close and destroy the owned stream object if any.
|
|
*/
|
|
void CloseStream();
|
|
|
|
/**
|
|
If enabled the file will be removed from disk when the dtor is called ( default is not enabled )
|
|
*/
|
|
void EnableKillingFile( bool bEnable=true )
|
|
{ bKillingFileEnabled = bEnable; }
|
|
|
|
/**
|
|
Only create a "physical" file name for a temporary file that would be valid at that moment.
|
|
Should only be used for 3rd party code with a file name interface that wants to create the file by itself.
|
|
If you want to convert file name into a URL, always use class LocalFileHelper, but never use any
|
|
conversion functions of osl.
|
|
*/
|
|
static OUString CreateTempName();
|
|
|
|
/**
|
|
The TempNameBaseDirectory is a subfolder in the folder that is passed as a "physical" file name in the
|
|
SetTempNameBaseDirectory method.
|
|
This subfolder will be used if a TempFile or TempName is created without a parent name or a parent name
|
|
that does not belong to the local file system.
|
|
The caller of the SetTempNameBase is responsible for deleting this folder and all temporary files in it.
|
|
The return value of both methods is the complete "physical" name of the tempname base folder.
|
|
It is not a URL because all URLs must be "UCB compatible", so there may be no suitable URL at all.
|
|
*/
|
|
static OUString SetTempNameBaseDirectory( const OUString &rBaseName );
|
|
|
|
// Return the URL of the temp directory (the one set with SetTempNameBaseDirectory or the
|
|
// default tempfile folder):
|
|
static OUString GetTempNameBaseDirectory();
|
|
};
|
|
|
|
}
|
|
|
|
#endif
|
|
|
|
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|