fbintf/client/FBTransaction.pas

(*
 *  Firebird Interface (fbintf). The fbintf components provide a set of
 *  Pascal language bindings for the Firebird API. Although predominantly
 *  a new development they include source code taken from IBX and may be
 *  considered a derived product. This software thus also includes the copyright
 *  notice and license conditions from IBX.
 *
 *  Except for those parts dervied from IBX, contents of this file are subject
 *  to the Initial Developer's Public License Version 1.0 (the "License"); you
 *  may not use this file except in compliance with the License. You may obtain a
 *  copy of the License here:
 *
 *    http://www.firebirdsql.org/index.php?op=doc&id=idpl
 *
 *  Software distributed under the License is distributed on an "AS
 *  IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
 *  implied. See the License for the specific language governing rights
 *  and limitations under the License.
 *
 *  The Initial Developer of the Original Code is Tony Whyman.
 *
 *  The Original Code is (C) 2016 Tony Whyman, MWA Software
 *  (http://www.mwasoftware.co.uk).
 *
 *  All Rights Reserved.
 *
 *  Contributor(s): ______________________________________.
 *
*)
{************************************************************************}
{                                                                        }
{       Borland Delphi Visual Component Library                          }
{       InterBase Express core components                                }
{                                                                        }
{       Copyright (c) 1998-2000 Inprise Corporation                      }
{                                                                        }
{    InterBase Express is based in part on the product                   }
{    Free IB Components, written by Gregory H. Deatz for                 }
{    Hoagland, Longo, Moran, Dunst & Doukas Company.                     }
{    Free IB Components is used under license.                           }
{                                                                        }
{    The contents of this file are subject to the InterBase              }
{    Public License Version 1.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.Inprise.com/IPL.html }
{    Software distributed under the License is distributed on            }
{    an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, either              }
{    express or implied. See the License for the specific language       }
{    governing rights and limitations under the License.                 }
{    The Original Code was created by InterBase Software Corporation     }
{       and its successors.                                              }
{    Portions created by Inprise Corporation are Copyright (C) Inprise   }
{       Corporation. All Rights Reserved.                                }
{    Contributor(s): Jeff Overcash                                       }
{                                                                        }
{    IBX For Lazarus (Firebird Express)                                  }
{    Contributor: Tony Whyman, MWA Software http://www.mwasoftware.co.uk }
{    Portions created by MWA Software are copyright McCallum Whyman      }
{    Associates Ltd 2011 - 2015                                                }
{                                                                        }
{************************************************************************}
unit FBTransaction;
{$IFDEF MSWINDOWS} 
{$DEFINE WINDOWS} 
{$ENDIF}

{$IFDEF FPC}
{$mode delphi}
{$interfaces COM}
{$ENDIF}

interface

uses
  Classes, SysUtils, IB, FBParamBlock, FBActivityMonitor, FBClientAPI;

type
  { TFBTransaction }

  TFBTransaction = class(TActivityReporter, IActivityMonitor,ITransaction)
  private
    FFirebirdAPI: TFBClientAPI;
    function GenerateTPB(sl: array of byte): ITPB;
  protected
    FTPB: ITPB;
    FSeqNo: integer;
    FDefaultCompletion: TTransactionAction;
    FAttachments: array of IAttachment; {Keep reference to attachment - ensures
                                          attachment cannot be freed before transaction}
    function GetActivityIntf(att: IAttachment): IActivityMonitor; virtual; abstract;
    procedure SetInterface(api: TFBClientAPI); virtual;
  public
    constructor Create(api: TFBClientAPI; Attachments: array of IAttachment; Params: array of byte; DefaultCompletion: TTransactionAction); overload;
    constructor Create(api: TFBClientAPI; Attachments: array of IAttachment; TPB: ITPB; DefaultCompletion: TTransactionAction); overload;
    constructor Create(api: TFBClientAPI; Attachment: IAttachment; Params: array of byte; DefaultCompletion: TTransactionAction); overload;
    constructor Create(api: TFBClientAPI; Attachment: IAttachment; TPB: ITPB; DefaultCompletion: TTransactionAction); overload;
    destructor Destroy; override;
    procedure DoDefaultTransactionEnd(Force: boolean);
    property FirebirdAPI: TFBClientAPI read FFirebirdAPI;

  public
    {ITransaction}
    function getTPB: ITPB;
    procedure PrepareForCommit;virtual; abstract;
    procedure Commit(Force: boolean=false);  virtual; abstract;
    procedure CommitRetaining;  virtual; abstract;
    function GetInTransaction: boolean; virtual; abstract;
    function GetAttachmentCount: integer;
    function GetAttachment(index: integer): IAttachment;
    procedure Rollback(Force: boolean=false);  virtual; abstract;
    procedure RollbackRetaining;  virtual; abstract;
    procedure Start(DefaultCompletion: TTransactionCompletion=taCommit); overload; virtual; abstract;
    procedure Start(TPB: ITPB; DefaultCompletion: TTransactionCompletion=taCommit); overload;

    property InTransaction: boolean read GetInTransaction;
    property TransactionSeqNo: integer read FSeqNo;
  end;

implementation

uses FBMessages, FBStatement;

{ TFBTransaction }

function TFBTransaction.GenerateTPB(sl: array of byte): ITPB;
var
  i: Integer;
begin
  Result := TTPB.Create(FFirebirdAPI);
  for i := 0 to Length(sl) - 1 do
    Result.Add(sl[i]);
end;

procedure TFBTransaction.SetInterface(api: TFBClientAPI);
begin
  FFirebirdAPI := api;
end;

constructor TFBTransaction.Create(api: TFBClientAPI; Attachments: array of IAttachment;
  Params: array of byte; DefaultCompletion: TTransactionAction);
begin
  Create(api, Attachments,GenerateTPB(Params), DefaultCompletion);
end;

constructor TFBTransaction.Create(api: TFBClientAPI; Attachments: array of IAttachment; TPB: ITPB;
  DefaultCompletion: TTransactionAction);
var
  i: Integer;
begin
  inherited Create(nil);
  SetInterface(api);
  if Length(Attachments) = 0 then
    IBError(ibxeEmptyAttachmentsList,[nil]);

  {make sure all attachments use same Firebird API}
  for i := 0 to Length(Attachments) - 1 do
    if Attachments[i].getFirebirdAPI.GetFBLibrary.GetHandle <> FFirebirdAPI.GetFBLibrary.GetHandle then
      IBError(ibxeDifferentAPIs,[nil]);

  SetLength(FAttachments,Length(Attachments));
  for i := 0 to Length(Attachments) - 1 do
  begin
    AddMonitor(GetActivityIntf(Attachments[i]));
    FAttachments[i] := Attachments[i];
  end;
  FTPB := TPB;
  Start(DefaultCompletion);
end;

constructor TFBTransaction.Create(api: TFBClientAPI; Attachment: IAttachment;
  Params: array of byte; DefaultCompletion: TTransactionAction);
begin
  Create(api,Attachment,GenerateTPB(Params),DefaultCompletion);
end;

constructor TFBTransaction.Create(api: TFBClientAPI; Attachment: IAttachment; TPB: ITPB;
  DefaultCompletion: TTransactionAction);
begin
  inherited Create(nil);
  SetInterface(api);
  AddMonitor(GetActivityIntf(Attachment));
  SetLength(FAttachments,1);
  FAttachments[0] := Attachment;
  FTPB := TPB;
  Start(DefaultCompletion);
end;

destructor TFBTransaction.Destroy;
begin
  DoDefaultTransactionEnd(false);
  inherited Destroy;
end;

procedure TFBTransaction.DoDefaultTransactionEnd(Force: boolean);
var i: integer;
    intf: TInterfacedObject;
begin
  if InTransaction then
  begin
    for i := 0 to InterfaceCount - 1 do
    begin
      intf := GetInterface(i);
      if (intf <> nil) and  (intf is TFBStatement) then
        TFBStatement(intf).TransactionEnding(self,Force);
    end;
    case FDefaultCompletion of
    taRollback:
      Rollback(Force);
    taCommit:
      Commit(Force);
    end;
  end;
end;

function TFBTransaction.getTPB: ITPB;
begin
  Result := FTPB;
end;

function TFBTransaction.GetAttachmentCount: integer;
begin
  Result := Length(FAttachments);
end;

function TFBTransaction.GetAttachment(index: integer): IAttachment;
begin
  if (index >= 0) and (index < Length(FAttachments)) then
    Result := FAttachments[index]
  else
    IBError(ibxeAttachmentListIndexError,[index]);
end;

procedure TFBTransaction.Start(TPB: ITPB; DefaultCompletion: TTransactionCompletion
  );
begin
  FTPB := TPB;
  Start(DefaultCompletion);
end;

end.

Revision:	263
Committed:	Thu Dec 6 15:55:01 2018 UTC (5 years, 4 months ago) by tony
Content type:	text/x-pascal
Original Path:	*ibx/trunk/fbintf/client/FBTransaction.pas*
File size:	8969 byte(s)
Log Message:	Release 2.3.2 committed
#	User	Rev	Content
1	tony	45	(*
2			* Firebird Interface (fbintf). The fbintf components provide a set of
3			* Pascal language bindings for the Firebird API. Although predominantly
4			* a new development they include source code taken from IBX and may be
5			* considered a derived product. This software thus also includes the copyright
6			* notice and license conditions from IBX.
7			*
8			* Except for those parts dervied from IBX, contents of this file are subject
9			* to the Initial Developer's Public License Version 1.0 (the "License"); you
10			* may not use this file except in compliance with the License. You may obtain a
11			* copy of the License here:
12			*
13			* http://www.firebirdsql.org/index.php?op=doc&id=idpl
14			*
15			* Software distributed under the License is distributed on an "AS
16			* IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
17			* implied. See the License for the specific language governing rights
18			* and limitations under the License.
19			*
20			* The Initial Developer of the Original Code is Tony Whyman.
21			*
22			* The Original Code is (C) 2016 Tony Whyman, MWA Software
23			* (http://www.mwasoftware.co.uk).
24			*
25			* All Rights Reserved.
26			*
27			* Contributor(s): ______________________________________.
28			*
29			*)
30			{************************************************************************}
31			{ }
32			{ Borland Delphi Visual Component Library }
33			{ InterBase Express core components }
34			{ }
35			{ Copyright (c) 1998-2000 Inprise Corporation }
36			{ }
37			{ InterBase Express is based in part on the product }
38			{ Free IB Components, written by Gregory H. Deatz for }
39			{ Hoagland, Longo, Moran, Dunst & Doukas Company. }
40			{ Free IB Components is used under license. }
41			{ }
42			{ The contents of this file are subject to the InterBase }
43			{ Public License Version 1.0 (the "License"); you may not }
44			{ use this file except in compliance with the License. You }
45			{ may obtain a copy of the License at http://www.Inprise.com/IPL.html }
46			{ Software distributed under the License is distributed on }
47			{ an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, either }
48			{ express or implied. See the License for the specific language }
49			{ governing rights and limitations under the License. }
50			{ The Original Code was created by InterBase Software Corporation }
51			{ and its successors. }
52			{ Portions created by Inprise Corporation are Copyright (C) Inprise }
53			{ Corporation. All Rights Reserved. }
54			{ Contributor(s): Jeff Overcash }
55			{ }
56			{ IBX For Lazarus (Firebird Express) }
57			{ Contributor: Tony Whyman, MWA Software http://www.mwasoftware.co.uk }
58			{ Portions created by MWA Software are copyright McCallum Whyman }
59			{ Associates Ltd 2011 - 2015 }
60			{ }
61			{************************************************************************}
62			unit FBTransaction;
63	tony	56	{$IFDEF MSWINDOWS}
64			{$DEFINE WINDOWS}
65			{$ENDIF}
66	tony	45
67			{$IFDEF FPC}
68	tony	56	{$mode delphi}
69	tony	45	{$interfaces COM}
70			{$ENDIF}
71
72			interface
73
74			uses
75	tony	263	Classes, SysUtils, IB, FBParamBlock, FBActivityMonitor, FBClientAPI;
76	tony	45
77			type
78			{ TFBTransaction }
79
80			TFBTransaction = class(TActivityReporter, IActivityMonitor,ITransaction)
81			private
82	tony	263	FFirebirdAPI: TFBClientAPI;
83	tony	45	function GenerateTPB(sl: array of byte): ITPB;
84			protected
85			FTPB: ITPB;
86			FSeqNo: integer;
87			FDefaultCompletion: TTransactionAction;
88			FAttachments: array of IAttachment; {Keep reference to attachment - ensures
89			attachment cannot be freed before transaction}
90			function GetActivityIntf(att: IAttachment): IActivityMonitor; virtual; abstract;
91	tony	263	procedure SetInterface(api: TFBClientAPI); virtual;
92	tony	45	public
93	tony	263	constructor Create(api: TFBClientAPI; Attachments: array of IAttachment; Params: array of byte; DefaultCompletion: TTransactionAction); overload;
94			constructor Create(api: TFBClientAPI; Attachments: array of IAttachment; TPB: ITPB; DefaultCompletion: TTransactionAction); overload;
95			constructor Create(api: TFBClientAPI; Attachment: IAttachment; Params: array of byte; DefaultCompletion: TTransactionAction); overload;
96			constructor Create(api: TFBClientAPI; Attachment: IAttachment; TPB: ITPB; DefaultCompletion: TTransactionAction); overload;
97	tony	45	destructor Destroy; override;
98			procedure DoDefaultTransactionEnd(Force: boolean);
99	tony	263	property FirebirdAPI: TFBClientAPI read FFirebirdAPI;
100	tony	45
101			public
102			{ITransaction}
103			function getTPB: ITPB;
104			procedure PrepareForCommit;virtual; abstract;
105			procedure Commit(Force: boolean=false); virtual; abstract;
106			procedure CommitRetaining; virtual; abstract;
107			function GetInTransaction: boolean; virtual; abstract;
108			function GetAttachmentCount: integer;
109			function GetAttachment(index: integer): IAttachment;
110			procedure Rollback(Force: boolean=false); virtual; abstract;
111			procedure RollbackRetaining; virtual; abstract;
112			procedure Start(DefaultCompletion: TTransactionCompletion=taCommit); overload; virtual; abstract;
113			procedure Start(TPB: ITPB; DefaultCompletion: TTransactionCompletion=taCommit); overload;
114
115			property InTransaction: boolean read GetInTransaction;
116			property TransactionSeqNo: integer read FSeqNo;
117			end;
118
119			implementation
120
121			uses FBMessages, FBStatement;
122
123			{ TFBTransaction }
124
125			function TFBTransaction.GenerateTPB(sl: array of byte): ITPB;
126			var
127			i: Integer;
128			begin
129	tony	263	Result := TTPB.Create(FFirebirdAPI);
130	tony	45	for i := 0 to Length(sl) - 1 do
131			Result.Add(sl[i]);
132			end;
133
134	tony	263	procedure TFBTransaction.SetInterface(api: TFBClientAPI);
135			begin
136			FFirebirdAPI := api;
137			end;
138
139			constructor TFBTransaction.Create(api: TFBClientAPI; Attachments: array of IAttachment;
140	tony	45	Params: array of byte; DefaultCompletion: TTransactionAction);
141			begin
142	tony	263	Create(api, Attachments,GenerateTPB(Params), DefaultCompletion);
143	tony	45	end;
144
145	tony	263	constructor TFBTransaction.Create(api: TFBClientAPI; Attachments: array of IAttachment; TPB: ITPB;
146	tony	45	DefaultCompletion: TTransactionAction);
147			var
148			i: Integer;
149			begin
150			inherited Create(nil);
151	tony	263	SetInterface(api);
152	tony	45	if Length(Attachments) = 0 then
153			IBError(ibxeEmptyAttachmentsList,[nil]);
154
155	tony	263	{make sure all attachments use same Firebird API}
156			for i := 0 to Length(Attachments) - 1 do
157			if Attachments[i].getFirebirdAPI.GetFBLibrary.GetHandle <> FFirebirdAPI.GetFBLibrary.GetHandle then
158			IBError(ibxeDifferentAPIs,[nil]);
159
160	tony	45	SetLength(FAttachments,Length(Attachments));
161			for i := 0 to Length(Attachments) - 1 do
162			begin
163			AddMonitor(GetActivityIntf(Attachments[i]));
164			FAttachments[i] := Attachments[i];
165			end;
166			FTPB := TPB;
167			Start(DefaultCompletion);
168			end;
169
170	tony	263	constructor TFBTransaction.Create(api: TFBClientAPI; Attachment: IAttachment;
171	tony	45	Params: array of byte; DefaultCompletion: TTransactionAction);
172			begin
173	tony	263	Create(api,Attachment,GenerateTPB(Params),DefaultCompletion);
174	tony	45	end;
175
176	tony	263	constructor TFBTransaction.Create(api: TFBClientAPI; Attachment: IAttachment; TPB: ITPB;
177	tony	45	DefaultCompletion: TTransactionAction);
178			begin
179			inherited Create(nil);
180	tony	263	SetInterface(api);
181	tony	45	AddMonitor(GetActivityIntf(Attachment));
182			SetLength(FAttachments,1);
183			FAttachments[0] := Attachment;
184			FTPB := TPB;
185			Start(DefaultCompletion);
186			end;
187
188			destructor TFBTransaction.Destroy;
189			begin
190			DoDefaultTransactionEnd(false);
191			inherited Destroy;
192			end;
193
194			procedure TFBTransaction.DoDefaultTransactionEnd(Force: boolean);
195			var i: integer;
196			intf: TInterfacedObject;
197			begin
198			if InTransaction then
199			begin
200			for i := 0 to InterfaceCount - 1 do
201			begin
202			intf := GetInterface(i);
203			if (intf <> nil) and (intf is TFBStatement) then
204			TFBStatement(intf).TransactionEnding(self,Force);
205			end;
206			case FDefaultCompletion of
207			taRollback:
208			Rollback(Force);
209			taCommit:
210			Commit(Force);
211			end;
212			end;
213			end;
214
215			function TFBTransaction.getTPB: ITPB;
216			begin
217			Result := FTPB;
218			end;
219
220			function TFBTransaction.GetAttachmentCount: integer;
221			begin
222			Result := Length(FAttachments);
223			end;
224
225			function TFBTransaction.GetAttachment(index: integer): IAttachment;
226			begin
227			if (index >= 0) and (index < Length(FAttachments)) then
228			Result := FAttachments[index]
229			else
230			IBError(ibxeAttachmentListIndexError,[index]);
231			end;
232
233			procedure TFBTransaction.Start(TPB: ITPB; DefaultCompletion: TTransactionCompletion
234			);
235			begin
236			FTPB := TPB;
237			Start(DefaultCompletion);
238			end;
239
240			end.
241