/*
* 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
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
using System;
namespace Lucene.Net.Store
{
/// Implements {@link LockFactory} using {@link
/// File#createNewFile()}.
///
/// NOTE: the javadocs
/// for File.createNewFile
contain a vague
/// yet spooky warning about not using the API for file
/// locking. This warning was added due to this
/// bug, and in fact the only known problem with using
/// this API for locking is that the Lucene write lock may
/// not be released when the JVM exits abnormally.
/// When this happens, a {@link LockObtainFailedException}
/// is hit when trying to create a writer, in which case you
/// need to explicitly clear the lock file first. You can
/// either manually remove the file, or use the {@link
/// org.apache.lucene.index.IndexReader#unlock(Directory)}
/// API. But, first be certain that no writer is in fact
/// writing to the index otherwise you can easily corrupt
/// your index.
///
/// If you suspect that this or any other LockFactory is
/// not working properly in your environment, you can easily
/// test it by using {@link VerifyingLockFactory}, {@link
/// LockVerifyServer} and {@link LockStressTest}.
///
///
///
///
public class SimpleFSLockFactory:FSLockFactory
{
/// Create a SimpleFSLockFactory instance, with null (unset)
/// lock directory. When you pass this factory to a {@link FSDirectory}
/// subclass, the lock directory is automatically set to the
/// directory itsself. Be sure to create one instance for each directory
/// your create!
///
public SimpleFSLockFactory():this((System.IO.DirectoryInfo) null)
{
}
/// Instantiate using the provided directory (as a File instance).
/// where lock files should be created.
///
[System.Obsolete("Use the constructor that takes a DirectoryInfo, this will be removed in the 3.0 release")]
public SimpleFSLockFactory(System.IO.FileInfo lockDir)
{
SetLockDir(new System.IO.DirectoryInfo(lockDir.FullName));
}
/// Instantiate using the provided directory (as a File instance).
/// where lock files should be created.
///
public SimpleFSLockFactory(System.IO.DirectoryInfo lockDir)
{
SetLockDir(lockDir);
}
/// Instantiate using the provided directory name (String).
/// where lock files should be created.
///
public SimpleFSLockFactory(System.String lockDirName)
{
lockDir = new System.IO.DirectoryInfo(lockDirName);
SetLockDir(lockDir);
}
public override Lock MakeLock(System.String lockName)
{
if (lockPrefix != null)
{
lockName = lockPrefix + "-" + lockName;
}
return new SimpleFSLock(lockDir, lockName);
}
public override void ClearLock(System.String lockName)
{
bool tmpBool;
if (System.IO.File.Exists(lockDir.FullName))
tmpBool = true;
else
tmpBool = System.IO.Directory.Exists(lockDir.FullName);
if (tmpBool)
{
if (lockPrefix != null)
{
lockName = lockPrefix + "-" + lockName;
}
System.IO.FileInfo lockFile = new System.IO.FileInfo(System.IO.Path.Combine(lockDir.FullName, lockName));
bool tmpBool2;
if (System.IO.File.Exists(lockFile.FullName))
tmpBool2 = true;
else
tmpBool2 = System.IO.Directory.Exists(lockFile.FullName);
bool tmpBool3;
if (System.IO.File.Exists(lockFile.FullName))
{
System.IO.File.Delete(lockFile.FullName);
tmpBool3 = true;
}
else if (System.IO.Directory.Exists(lockFile.FullName))
{
System.IO.Directory.Delete(lockFile.FullName);
tmpBool3 = true;
}
else
tmpBool3 = false;
if (tmpBool2 && !tmpBool3)
{
throw new System.IO.IOException("Cannot delete " + lockFile);
}
}
}
}
class SimpleFSLock:Lock
{
internal System.IO.FileInfo lockFile;
internal System.IO.DirectoryInfo lockDir;
[System.Obsolete("Use the constructor that takes a DirectoryInfo, this will be removed in the 3.0 release")]
public SimpleFSLock(System.IO.FileInfo lockDir, System.String lockFileName) : this(new System.IO.DirectoryInfo(lockDir.FullName), lockFileName)
{
}
public SimpleFSLock(System.IO.DirectoryInfo lockDir, System.String lockFileName)
{
this.lockDir = new System.IO.DirectoryInfo(lockDir.FullName);
lockFile = new System.IO.FileInfo(System.IO.Path.Combine(lockDir.FullName, lockFileName));
}
public override bool Obtain()
{
// Ensure that lockDir exists and is a directory:
bool tmpBool;
if (System.IO.File.Exists(lockDir.FullName))
tmpBool = true;
else
tmpBool = System.IO.Directory.Exists(lockDir.FullName);
if (!tmpBool)
{
try
{
System.IO.Directory.CreateDirectory(lockDir.FullName);
}
catch
{
throw new System.IO.IOException("Cannot create directory: " + lockDir.FullName);
}
}
else
{
try
{
System.IO.Directory.Exists(lockDir.FullName);
}
catch
{
throw new System.IO.IOException("Found regular file where directory expected: " + lockDir.FullName);
}
}
if (lockFile.Exists)
{
return false;
}
else
{
System.IO.FileStream createdFile = lockFile.Create();
createdFile.Close();
return true;
}
}
public override void Release()
{
bool tmpBool;
if (System.IO.File.Exists(lockFile.FullName))
tmpBool = true;
else
tmpBool = System.IO.Directory.Exists(lockFile.FullName);
bool tmpBool2;
if (System.IO.File.Exists(lockFile.FullName))
{
System.IO.File.Delete(lockFile.FullName);
tmpBool2 = true;
}
else if (System.IO.Directory.Exists(lockFile.FullName))
{
System.IO.Directory.Delete(lockFile.FullName);
tmpBool2 = true;
}
else
tmpBool2 = false;
if (tmpBool && !tmpBool2)
throw new LockReleaseFailedException("failed to delete " + lockFile);
}
public override bool IsLocked()
{
bool tmpBool;
if (System.IO.File.Exists(lockFile.FullName))
tmpBool = true;
else
tmpBool = System.IO.Directory.Exists(lockFile.FullName);
return tmpBool;
}
public override System.String ToString()
{
return "SimpleFSLock@" + lockFile;
}
}
}