OSX/libsecurity_utilities/lib/FileLockTransaction.h

   1 /*
   2  * Copyright (c) 2015 Apple Inc. All Rights Reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. Please obtain a copy of the License at
  10  * http://www.opensource.apple.com/apsl/ and read it before using this
  11  * file.
  12  *
  13  * The Original Code and all software distributed under the License are
  14  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  15  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  16  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  18  * Please see the License for the specific language governing rights and
  19  * limitations under the License.
  20  *
  21  * @APPLE_LICENSE_HEADER_END@
  22  */
  23
  24 #ifndef FileLockTransaction_h
  25 #define FileLockTransaction_h
  26
  27 #if TARGET_OS_OSX
  28
  29 #include <security_cdsa_client/dlclient.h>
  30 //
  31 // This class performs a file lock transaction on a Cssm Db object.
  32 //
  33 // It will attempt to take the file lock upon creation.
  34 //
  35 // It will release the file lock upon destruction OR calling finalize().
  36 //
  37 // If you have called success(), it will tell the file lock transaction to commit
  38 // otherwise, it will tell the file lock transaction to roll back.
  39 //
  40 // If you call setDeleteOnFailure(), and the transaction would normally roll
  41 // back, this transaction will instead delete the Db's underlying file.
  42 //
  43 class FileLockTransaction {
  44 public:
  45     FileLockTransaction(Security::CssmClient::Db& db);
  46
  47     ~FileLockTransaction();
  48
  49     // Everything has gone right; this transaction will commit.
  50     // If you don't call this, the transaction will roll back.
  51     void success();
  52
  53     // Commit or rollback as appropriate
  54     void finalize();
  55
  56     // After calling this method, if this class attempts to roll back the
  57     // transaction, it will also attempt to delete the database file.
  58     void setDeleteOnFailure();
  59
  60 protected:
  61     // Actually toggle autocommit using the dldbh
  62     void initialize();
  63
  64     Security::CssmClient::Db mDb;
  65
  66     bool mSuccess;
  67     bool mFinalized;
  68     bool mDeleteOnFailure;
  69 };
  70
  71 #endif // TARGET_OS_OSX
  72
  73 #endif