/* Copyright (C) 2008-2016 Peter Palotas, Jeffrey Jangli, Alexandr Normuradov
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
using System;
using System.IO;
using System.Security;
namespace Alphaleonis.Win32.Filesystem
{
partial class FileInfo
{
#region CopyTo
#region .NET
/// Copies an existing file to a new file, disallowing the overwriting of an existing file.
/// A new instance with a fully qualified path.
///
/// Use this method to prevent overwriting of an existing file by default.
/// Whenever possible, avoid using short file names (such as XXXXXX~1.XXX) with this method.
/// If two files have equivalent short file names then this method may fail and raise an exception and/or result in undesirable behavior.
///
///
/// A new instance with a fully qualified path.
///
///
///
///
///
///
///
/// The name of the new file to copy to.
[SecurityCritical]
public FileInfo CopyTo(string destinationPath)
{
string destinationPathLp;
CopyToMoveToCore(destinationPath, false, CopyOptions.FailIfExists, null, null, null, out destinationPathLp, PathFormat.RelativePath);
return new FileInfo(Transaction, destinationPathLp, PathFormat.LongFullPath);
}
/// Copies an existing file to a new file, allowing the overwriting of an existing file.
///
/// Use this method to allow or prevent overwriting of an existing file.
/// Whenever possible, avoid using short file names (such as XXXXXX~1.XXX) with this method.
/// If two files have equivalent short file names then this method may fail and raise an exception and/or result in undesirable behavior.
///
///
/// A new instance with a fully qualified path.
///
///
///
///
///
///
///
/// The name of the new file to copy to.
/// to allow an existing file to be overwritten; otherwise, .
[SecurityCritical]
public FileInfo CopyTo(string destinationPath, bool overwrite)
{
string destinationPathLp;
CopyToMoveToCore(destinationPath, false, overwrite ? CopyOptions.None : CopyOptions.FailIfExists, null, null, null, out destinationPathLp, PathFormat.RelativePath);
return new FileInfo(Transaction, destinationPathLp, PathFormat.LongFullPath);
}
#endregion // .NET
#region AlphaFS
/// [AlphaFS] Copies an existing file to a new file, disallowing the overwriting of an existing file.
///
/// Use this method to prevent overwriting of an existing file by default.
/// Whenever possible, avoid using short file names (such as XXXXXX~1.XXX) with this method.
/// If two files have equivalent short file names then this method may fail and raise an exception and/or result in undesirable behavior.
///
///
/// A new instance with a fully qualified path.
///
///
///
///
///
///
///
/// The name of the new file to copy to.
/// Indicates the format of the path parameter(s).
[SecurityCritical]
public FileInfo CopyTo(string destinationPath, PathFormat pathFormat)
{
string destinationPathLp;
CopyToMoveToCore(destinationPath, false, CopyOptions.FailIfExists, null, null, null, out destinationPathLp, pathFormat);
return new FileInfo(Transaction, destinationPathLp, PathFormat.LongFullPath);
}
/// [AlphaFS] Copies an existing file to a new file, allowing the overwriting of an existing file.
///
/// Use this method to allow or prevent overwriting of an existing file.
/// Whenever possible, avoid using short file names (such as XXXXXX~1.XXX) with this method.
/// If two files have equivalent short file names then this method may fail and raise an exception and/or result in undesirable behavior.
///
///
/// A new instance with a fully qualified path.
///
///
///
///
///
///
///
/// The name of the new file to copy to.
/// to allow an existing file to be overwritten; otherwise, .
/// Indicates the format of the path parameter(s).
[SecurityCritical]
public FileInfo CopyTo(string destinationPath, bool overwrite, PathFormat pathFormat)
{
string destinationPathLp;
CopyToMoveToCore(destinationPath, false, overwrite ? CopyOptions.None : CopyOptions.FailIfExists, null, null, null, out destinationPathLp, pathFormat);
return new FileInfo(Transaction, destinationPathLp, PathFormat.LongFullPath);
}
/// [AlphaFS] Copies an existing file to a new file, allowing the overwriting of an existing file, can be specified.
///
/// Option is recommended for very large file transfers.
/// Use this method to allow or prevent overwriting of an existing file.
/// Whenever possible, avoid using short file names (such as XXXXXX~1.XXX) with this method.
/// If two files have equivalent short file names then this method may fail and raise an exception and/or result in undesirable behavior.
///
///
/// A new instance with a fully qualified path.
///
///
///
///
///
///
///
/// The name of the new file to copy to.
/// that specify how the file is to be copied.
[SecurityCritical]
public FileInfo CopyTo(string destinationPath, CopyOptions copyOptions)
{
string destinationPathLp;
CopyToMoveToCore(destinationPath, false, copyOptions, null, null, null, out destinationPathLp, PathFormat.RelativePath);
return new FileInfo(Transaction, destinationPathLp, PathFormat.LongFullPath);
}
/// [AlphaFS] Copies an existing file to a new file, allowing the overwriting of an existing file, can be specified.
///
/// Option is recommended for very large file transfers.
/// Use this method to allow or prevent overwriting of an existing file.
/// Whenever possible, avoid using short file names (such as XXXXXX~1.XXX) with this method.
/// If two files have equivalent short file names then this method may fail and raise an exception and/or result in undesirable behavior.
///
///
/// A new instance with a fully qualified path.
///
///
///
///
///
///
///
/// The name of the new file to copy to.
/// that specify how the file is to be copied.
/// Indicates the format of the path parameter(s).
[SecurityCritical]
public FileInfo CopyTo(string destinationPath, CopyOptions copyOptions, PathFormat pathFormat)
{
string destinationPathLp;
CopyToMoveToCore(destinationPath, false, copyOptions, null, null, null, out destinationPathLp, pathFormat);
return new FileInfo(Transaction, destinationPathLp, PathFormat.LongFullPath);
}
/// [AlphaFS] Copies an existing file to a new file, allowing the overwriting of an existing file, can be specified.
///
/// Option is recommended for very large file transfers.
/// Use this method to allow or prevent overwriting of an existing file.
/// Whenever possible, avoid using short file names (such as XXXXXX~1.XXX) with this method.
/// If two files have equivalent short file names then this method may fail and raise an exception and/or result in undesirable behavior.
///
///
/// A new instance with a fully qualified path.
///
///
///
///
///
///
///
/// The name of the new file to copy to.
/// that specify how the file is to be copied.
/// if original Timestamps must be preserved, otherwise.
[SecurityCritical]
public FileInfo CopyTo(string destinationPath, CopyOptions copyOptions, bool preserveDates)
{
string destinationPathLp;
CopyToMoveToCore(destinationPath, preserveDates, copyOptions, null, null, null, out destinationPathLp, PathFormat.RelativePath);
return new FileInfo(Transaction, destinationPathLp, PathFormat.LongFullPath);
}
/// [AlphaFS] Copies an existing file to a new file, allowing the overwriting of an existing file, can be specified.
///
/// Option is recommended for very large file transfers.
/// Use this method to allow or prevent overwriting of an existing file.
/// Whenever possible, avoid using short file names (such as XXXXXX~1.XXX) with this method.
/// If two files have equivalent short file names then this method may fail and raise an exception and/or result in undesirable behavior.
///
///
/// A new instance with a fully qualified path.
///
///
///
///
///
///
///
/// The name of the new file to copy to.
/// that specify how the file is to be copied.
/// if original Timestamps must be preserved, otherwise.
/// Indicates the format of the path parameter(s).
[SecurityCritical]
public FileInfo CopyTo(string destinationPath, CopyOptions copyOptions, bool preserveDates, PathFormat pathFormat)
{
string destinationPathLp;
CopyToMoveToCore(destinationPath, preserveDates, copyOptions, null, null, null, out destinationPathLp, pathFormat);
return new FileInfo(Transaction, destinationPathLp, PathFormat.LongFullPath);
}
/// [AlphaFS] Copies an existing file to a new file, allowing the overwriting of an existing file, can be specified.
/// and the possibility of notifying the application of its progress through a callback function.
///
/// Option is recommended for very large file transfers.
/// Use this method to allow or prevent overwriting of an existing file.
/// Whenever possible, avoid using short file names (such as XXXXXX~1.XXX) with this method.
/// If two files have equivalent short file names then this method may fail and raise an exception and/or result in undesirable behavior.
///
///
/// A class with details of the Copy action.
///
///
///
///
///
///
///
/// The name of the new file to copy to.
/// that specify how the file is to be copied.
/// A callback function that is called each time another portion of the file has been copied. This parameter can be .
/// The argument to be passed to the callback function. This parameter can be .
[SecurityCritical]
public CopyMoveResult CopyTo(string destinationPath, CopyOptions copyOptions, CopyMoveProgressRoutine progressHandler, object userProgressData)
{
string destinationPathLp;
var cmr = CopyToMoveToCore(destinationPath, false, copyOptions, null, progressHandler, userProgressData, out destinationPathLp, PathFormat.RelativePath);
CopyToMoveToCoreRefresh(destinationPath, destinationPathLp);
return cmr;
}
/// [AlphaFS] Copies an existing file to a new file, allowing the overwriting of an existing file, can be specified.
///
/// Option is recommended for very large file transfers.
/// Use this method to allow or prevent overwriting of an existing file.
/// Whenever possible, avoid using short file names (such as XXXXXX~1.XXX) with this method.
/// If two files have equivalent short file names then this method may fail and raise an exception and/or result in undesirable behavior.
///
///
/// A class with details of the Copy action.
///
///
///
///
///
///
///
/// The name of the new file to copy to.
/// that specify how the file is to be copied.
/// A callback function that is called each time another portion of the file has been copied. This parameter can be .
/// The argument to be passed to the callback function. This parameter can be .
/// Indicates the format of the path parameter(s).
[SecurityCritical]
public CopyMoveResult CopyTo(string destinationPath, CopyOptions copyOptions, CopyMoveProgressRoutine progressHandler, object userProgressData, PathFormat pathFormat)
{
string destinationPathLp;
var cmr = CopyToMoveToCore(destinationPath, false, copyOptions, null, progressHandler, userProgressData, out destinationPathLp, pathFormat);
CopyToMoveToCoreRefresh(destinationPath, destinationPathLp);
return cmr;
}
/// [AlphaFS] Copies an existing file to a new file, allowing the overwriting of an existing file, can be specified.
/// and the possibility of notifying the application of its progress through a callback function.
///
/// Option is recommended for very large file transfers.
/// Use this method to allow or prevent overwriting of an existing file.
/// Whenever possible, avoid using short file names (such as XXXXXX~1.XXX) with this method.
/// If two files have equivalent short file names then this method may fail and raise an exception and/or result in undesirable behavior.
///
///
/// A class with details of the Copy action.
///
///
///
///
///
///
///
/// The name of the new file to copy to.
/// that specify how the file is to be copied.
/// if original Timestamps must be preserved, otherwise.
/// A callback function that is called each time another portion of the file has been copied. This parameter can be .
/// The argument to be passed to the callback function. This parameter can be .
[SecurityCritical]
public CopyMoveResult CopyTo(string destinationPath, CopyOptions copyOptions, bool preserveDates, CopyMoveProgressRoutine progressHandler, object userProgressData)
{
string destinationPathLp;
var cmr = CopyToMoveToCore(destinationPath, preserveDates, copyOptions, null, progressHandler, userProgressData, out destinationPathLp, PathFormat.RelativePath);
CopyToMoveToCoreRefresh(destinationPath, destinationPathLp);
return cmr;
}
/// [AlphaFS] Copies an existing file to a new file, allowing the overwriting of an existing file, can be specified.
/// and the possibility of notifying the application of its progress through a callback function.
///
/// Option is recommended for very large file transfers.
/// Use this method to allow or prevent overwriting of an existing file.
/// Whenever possible, avoid using short file names (such as XXXXXX~1.XXX) with this method.
/// If two files have equivalent short file names then this method may fail and raise an exception and/or result in undesirable behavior.
///
///
/// A class with details of the Copy action.
///
///
///
///
///
///
///
/// The name of the new file to copy to.
/// that specify how the file is to be copied.
/// if original Timestamps must be preserved, otherwise.
/// A callback function that is called each time another portion of the file has been copied. This parameter can be .
/// The argument to be passed to the callback function. This parameter can be .
/// Indicates the format of the path parameter(s).
[SecurityCritical]
public CopyMoveResult CopyTo(string destinationPath, CopyOptions copyOptions, bool preserveDates, CopyMoveProgressRoutine progressHandler, object userProgressData, PathFormat pathFormat)
{
string destinationPathLp;
var cmr = CopyToMoveToCore(destinationPath, preserveDates, copyOptions, null, progressHandler, userProgressData, out destinationPathLp, pathFormat);
CopyToMoveToCoreRefresh(destinationPath, destinationPathLp);
return cmr;
}
#endregion // AlphaFS
#endregion // CopyTo
#region MoveTo
#region .NET
/// Moves a specified file to a new location, providing the option to specify a new file name.
///
/// Use this method to prevent overwriting of an existing file by default.
/// This method works across disk volumes.
/// For example, the file c:\MyFile.txt can be moved to d:\public and renamed NewFile.txt.
/// Whenever possible, avoid using short file names (such as XXXXXX~1.XXX) with this method.
/// If two files have equivalent short file names then this method may fail and raise an exception and/or result in undesirable behavior.
///
///
/// A class with details of the Move action.
///
///
///
///
///
///
///
/// The path to move the file to, which can specify a different file name.
[SecurityCritical]
public CopyMoveResult MoveTo(string destinationPath)
{
string destinationPathLp;
var copyMoveResult = CopyToMoveToCore(destinationPath, false, null, MoveOptions.CopyAllowed, null, null, out destinationPathLp, PathFormat.RelativePath);
CopyToMoveToCoreRefresh(destinationPath, destinationPathLp);
return copyMoveResult;
}
#endregion // .NET
#region AlphaFS
/// [AlphaFS] Moves a specified file to a new location, providing the option to specify a new file name.
/// Returns a new instance with a fully qualified path when successfully moved,
///
/// Use this method to prevent overwriting of an existing file by default.
/// This method works across disk volumes.
/// For example, the file c:\MyFile.txt can be moved to d:\public and renamed NewFile.txt.
/// Whenever possible, avoid using short file names (such as XXXXXX~1.XXX) with this method.
/// If two files have equivalent short file names then this method may fail and raise an exception and/or result in undesirable
/// behavior.
///
///
///
///
///
///
///
///
///
/// The path to move the file to, which can specify a different file name.
/// Indicates the format of the path parameter(s).
[SecurityCritical]
public FileInfo MoveTo(string destinationPath, PathFormat pathFormat)
{
string destinationPathLp;
CopyToMoveToCore(destinationPath, false, null, MoveOptions.CopyAllowed, null, null, out destinationPathLp, pathFormat);
return new FileInfo(Transaction, destinationPathLp, PathFormat.LongFullPath);
}
/// [AlphaFS] Moves a specified file to a new location, providing the option to specify a new file name, can be specified.
/// Returns a new instance with a fully qualified path when successfully moved,
///
/// Use this method to allow or prevent overwriting of an existing file.
/// This method works across disk volumes.
/// For example, the file c:\MyFile.txt can be moved to d:\public and renamed NewFile.txt.
/// Whenever possible, avoid using short file names (such as XXXXXX~1.XXX) with this method.
/// If two files have equivalent short file names then this method may fail and raise an exception and/or result in undesirable
/// behavior.
///
///
///
///
///
///
///
///
///
/// The path to move the file to, which can specify a different file name.
/// that specify how the directory is to be moved. This parameter can be .
[SecurityCritical]
public FileInfo MoveTo(string destinationPath, MoveOptions moveOptions)
{
string destinationPathLp;
CopyToMoveToCore(destinationPath, false, null, moveOptions, null, null, out destinationPathLp, PathFormat.RelativePath);
return new FileInfo(Transaction, destinationPathLp, PathFormat.LongFullPath);
}
/// [AlphaFS] Moves a specified file to a new location, providing the option to specify a new file name, can be specified.
/// Returns a new instance with a fully qualified path when successfully moved,
///
/// Use this method to allow or prevent overwriting of an existing file.
/// This method works across disk volumes.
/// For example, the file c:\MyFile.txt can be moved to d:\public and renamed NewFile.txt.
/// Whenever possible, avoid using short file names (such as XXXXXX~1.XXX) with this method.
/// If two files have equivalent short file names then this method may fail and raise an exception and/or result in undesirable
/// behavior.
///
///
///
///
///
///
///
///
///
/// The path to move the file to, which can specify a different file name.
/// that specify how the directory is to be moved. This parameter can be .
/// Indicates the format of the path parameter(s).
[SecurityCritical]
public FileInfo MoveTo(string destinationPath, MoveOptions moveOptions, PathFormat pathFormat)
{
string destinationPathLp;
CopyToMoveToCore(destinationPath, false, null, moveOptions, null, null, out destinationPathLp, pathFormat);
return new FileInfo(Transaction, destinationPathLp, PathFormat.LongFullPath);
}
/// [AlphaFS] Moves a specified file to a new location, providing the option to specify a new file name, can be specified,
/// and the possibility of notifying the application of its progress through a callback function.
///
/// Use this method to allow or prevent overwriting of an existing file.
/// This method works across disk volumes.
/// For example, the file c:\MyFile.txt can be moved to d:\public and renamed NewFile.txt.
/// Whenever possible, avoid using short file names (such as XXXXXX~1.XXX) with this method.
/// If two files have equivalent short file names then this method may fail and raise an exception and/or result in undesirable behavior.
///
///
/// A class with the status of the Move action.
///
///
///
///
///
///
///
/// The path to move the file to, which can specify a different file name.
/// that specify how the directory is to be moved. This parameter can be .
/// A callback function that is called each time another portion of the directory has been moved. This parameter can be .
/// The argument to be passed to the callback function. This parameter can be .
[SecurityCritical]
public CopyMoveResult MoveTo(string destinationPath, MoveOptions moveOptions, CopyMoveProgressRoutine progressHandler, object userProgressData)
{
string destinationPathLp;
var cmr = CopyToMoveToCore(destinationPath, false, null, moveOptions, progressHandler, userProgressData, out destinationPathLp, PathFormat.RelativePath);
CopyToMoveToCoreRefresh(destinationPath, destinationPathLp);
return cmr;
}
/// [AlphaFS] Moves a specified file to a new location, providing the option to specify a new file name, can be specified.
///
/// Use this method to allow or prevent overwriting of an existing file.
/// This method works across disk volumes.
/// For example, the file c:\MyFile.txt can be moved to d:\public and renamed NewFile.txt.
/// Whenever possible, avoid using short file names (such as XXXXXX~1.XXX) with this method.
/// If two files have equivalent short file names then this method may fail and raise an exception and/or result in undesirable behavior.
///
///
/// A class with the status of the Move action.
///
///
///
///
///
///
///
/// The path to move the file to, which can specify a different file name.
/// that specify how the directory is to be moved. This parameter can be .
/// A callback function that is called each time another portion of the directory has been moved. This parameter can be .
/// The argument to be passed to the callback function. This parameter can be .
/// Indicates the format of the path parameter(s).
[SecurityCritical]
public CopyMoveResult MoveTo(string destinationPath, MoveOptions moveOptions, CopyMoveProgressRoutine progressHandler, object userProgressData, PathFormat pathFormat)
{
string destinationPathLp;
var cmr = CopyToMoveToCore(destinationPath, false, null, moveOptions, progressHandler, userProgressData, out destinationPathLp, pathFormat);
CopyToMoveToCoreRefresh(destinationPath, destinationPathLp);
return cmr;
}
#endregion // AlphaFS
#endregion // MoveTo
#region Internal Methods
/// Copy/move an existing file to a new file, allowing the overwriting of an existing file.
///
/// Option is recommended for very large file transfers.
/// Whenever possible, avoid using short file names (such as XXXXXX~1.XXX) with this method.
/// If two files have equivalent short file names then this method may fail and raise an exception and/or result in undesirable behavior.
///
///
/// A class with the status of the Copy or Move action.
/// A full path string to the destination directory
/// if original Timestamps must be preserved, otherwise.
/// This parameter can be . Use to specify how the file is to be copied.
/// This parameter can be . Use that specify how the file is to be moved.
/// This parameter can be . A callback function that is called each time another portion of the file has been copied.
/// This parameter can be . The argument to be passed to the callback function.
/// [out] Returns the retrieved long full path.
/// Indicates the format of the path parameter(s).
///
///
///
///
///
///
[SecurityCritical]
private CopyMoveResult CopyToMoveToCore(string destinationPath, bool preserveDates, CopyOptions? copyOptions, MoveOptions? moveOptions, CopyMoveProgressRoutine progressHandler, object userProgressData, out string longFullPath, PathFormat pathFormat)
{
var destinationPathLp = Path.GetExtendedLengthPathCore(Transaction, destinationPath, pathFormat, GetFullPathOptions.TrimEnd | GetFullPathOptions.RemoveTrailingDirectorySeparator | GetFullPathOptions.FullCheck);
longFullPath = destinationPathLp;
// Returns false when CopyMoveProgressResult is PROGRESS_CANCEL or PROGRESS_STOP.
return File.CopyMoveCore(false, Transaction, LongFullName, destinationPathLp, preserveDates, copyOptions, moveOptions, progressHandler, userProgressData, null, PathFormat.LongFullPath);
}
private void CopyToMoveToCoreRefresh(string destinationPath, string destinationPathLp)
{
LongFullName = destinationPathLp;
FullPath = Path.GetRegularPathCore(destinationPathLp, GetFullPathOptions.None, false);
OriginalPath = destinationPath;
DisplayPath = Path.GetRegularPathCore(OriginalPath, GetFullPathOptions.None, false);
_name = Path.GetFileName(destinationPathLp, true);
// Flush any cached information about the file.
Reset();
}
#endregion // Internal Methods
}
}