UserManagement.User

Unit
Source
Symbols

Symbol	Description
TUser	A user of an web application
TUserIdentifier
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
///////////////////////////////////////////////////////////////////////////
//                                                                       //
//  Copyright (c) 2015 by Charta Software B.V.                           //
//  All rights reserved                                                  //
//                                                                       //
//  Version:  1.7.0.83525                                                //
//  Web site: https://pascal.chartasoftware.com/                         //
//                                                                       //
//  This code and information are provided "as is" without warranty of   //
//  any kind. Dissemination of this information or reproduction of       //
//  this material is strictly forbidden unless prior written permission  //
//  is obtained from Charta Software B.V..                               //
//                                                                       //
///////////////////////////////////////////////////////////////////////////

unit UserManagement.User;

interface

uses
  Boolean,
  DateTime.Calendar.Gregorian.Instant,
  Integer._32,
  Mail.Address,
  {$IF not Defined(FPC)}
  Sql.Builder,
  Sql.Database,
  {$ENDIF}
  Text,
  Text.Random,
  Uuid,
  Uuid.Generator.Version4;

type
  TUserIdentifier = TInteger32;

  TUser = class(TObject)
  private
    FId:                 TUserIdentifier;
    FName:               TText;
    FEmail:              TText;
    FExposeEmail:        TBoolean;
    FEncryptedPassword:  TText;
    FInformed:           TBoolean;
    FConditionsAccepted: TBoolean;
    FPasswordSalt:       TText;
    FComments:           TText;
    FActivationCode:     TUuid;
    FActivatedInstant:   TGregorianInstant;

    procedure   SetActivatedInstant(const Value: TGregorianInstant);

    function    EncryptPassword(const Password: TText): TText;

  private
    UuidGenerator: TUuidGeneratorVersion4;

  protected
    {$IF not Defined(FPC)}
    class function  LoadFromDatabase(Database: TSqlDatabase; const Restrictions: array of TSqlExpressionBuilder): TUser;
    {$ENDIF}
    
  public
    const
      UNASSIGNED_IDENTIFIER = 0;

    constructor Create(); virtual;
    destructor  Destroy(); override;

    function    Copy(): TUser;

    procedure   SetPassword(const Password: TText);

    function    CheckPassword(const Password: TText): TBoolean;
    function    CheckEMailActivated(const Password: TText): TBoolean;

    function    Deprecated_GetIdentifier(): TUserIdentifier; deprecated;

    function    CreateMailAddress(): TMailAddress;
    procedure   GenerateActivationCode();

    {$IF not Defined(FPC)}
    procedure   CreateNewInDatabase(Database: TSqlDatabase);
    {$ENDIF}

  {$IF Defined(FPC)}public{$ELSE}published{$ENDIF}
    property    Id: TUserIdentifier read FId write FId;
    property    Name: TText read FName write FName;
    property    Email: TText read FEmail write FEmail;
    property    ExposeEmail: TBoolean read FExposeEmail write FExposeEmail;
    property    Informed: TBoolean read FInformed write FInformed;
    property    ConditionsAccepted: TBoolean read FConditionsAccepted write FConditionsAccepted;
    property    Comments: TText read FComments write FComments;
    property    PasswordSalt: TText read FPasswordSalt write FPasswordSalt;
    property    EncryptedPassword: TText read FEncryptedPassword write FEncryptedPassword;
    property    ActivationCode: TUuid read FActivationCode write FActivationCode;
    property    ActivatedInstant: TGregorianInstant read FActivatedInstant write SetActivatedInstant;

  public
    {$IF not Defined(FPC)}
    class function  LoadWithIdentifier(Database: TSqlDatabase; Identifier: TUserIdentifier): TUser;
    class function  LoadWithEMail(Database: TSqlDatabase; const EMail: TText): TUser;
    class function  LoadWithBearer(Database: TSqlDatabase; const Bearer: TUuid): TUser;
    {$ENDIF}

    class var
      PasswordGenerator:     TRandomText;
      PasswordSaltGenerator: TRandomText;

    class constructor Create();
    class destructor  Destroy();
  end;

implementation

uses
  Byte.Block.Format.Text,
  Hash.Algorithm.Md._5,
  Memory.Block,
  {$IF not Defined(FPC)}
  ObjectRelational.Mapper,
  Sql,
  Sql.Expression,
  Sql.Statement.ResultSet.Select,
  {$ENDIF}
  Text.Collation,
  Text.Value{$IF not Defined(FPC)},
  UserManagement.Table.Set_{$ENDIF};

{ TUser }

function TUser.CheckEMailActivated(const Password: TText): TBoolean;
begin
  Result := CheckPassword(Password) and (ActivatedInstant <> nil);
end;

function TUser.CheckPassword(const Password: TText): TBoolean;
begin
  Result := TTextCollation.DefaultCaseInsensitive.Equal(EncryptedPassword, EncryptPassword(Password));
end;

function TUser.Copy(): TUser;
begin
  Result := TUser.Create();
  Result.Id                 := Id;
  Result.Name               := Name;
  Result.Email              := Email;
  Result.ExposeEmail        := ExposeEmail;
  Result.Informed           := Informed;
  Result.ConditionsAccepted := ConditionsAccepted;
  Result.Comments           := Comments;
  Result.PasswordSalt       := PasswordSalt;
  Result.EncryptedPassword  := EncryptedPassword;
end;

constructor TUser.Create();
begin
  inherited Create();

  UuidGenerator := TUuidGeneratorVersion4.Create();
end;

class constructor TUser.Create();
begin
  PasswordGenerator     := TRandomText.Create(['a'..'z', 'A'..'Z', '0'..'9', '~', '!', '@', '#', '$', '%', '^', '&', '*', '(', ')', '_', '{', '}', '[', ']', ':', ';', '.', ','], 8);
  PasswordSaltGenerator := TRandomText.Create(['a'..'z', 'A'..'Z', '0'..'9', '~', '!', '@', '#', '$', '%', '^', '&', '*', '(', ')', '_', '{', '}', '[', ']', ':', ';', '.', ','], 8);
end;

function TUser.CreateMailAddress(): TMailAddress;
begin
  Result := TMailAddress.Create(Name, Email);
end;

{$IF not Defined(FPC)}
procedure TUser.CreateNewInDatabase(Database: TSqlDatabase);
begin
  Id := Database.Insert(
    InsertValues(
      UserManagementTableSet.UsersTable,
      [
        UserManagementTableSet.UsersTable.Email,
        UserManagementTableSet.UsersTable.PasswordSalt,
        UserManagementTableSet.UsersTable.EncryptedPassword,
        UserManagementTableSet.UsersTable.Name,
        UserManagementTableSet.UsersTable.Comments,
        UserManagementTableSet.UsersTable.ExposeEmail,
        UserManagementTableSet.UsersTable.Informed,
        UserManagementTableSet.UsersTable.ConditionsAccepted,
        UserManagementTableSet.UsersTable.ActivationCode,
        UserManagementTableSet.UsersTable.ActivatedInstant
      ],
      [
        Email,
        PasswordSalt,
        EncryptedPassword,
        Name,
        Comments,
        ExposeEmail,
        Informed,
        True,
        NilToNull(TTextValue.Create(ActivationCode.ToText())),
        NilToNull(ActivatedInstant)
      ]
    )
  );
end;
{$ENDIF}

function TUser.Deprecated_GetIdentifier(): TUserIdentifier;
begin
  if Self <> nil then
    Result := Id
  else
    Result := UNASSIGNED_IDENTIFIER;
end;

class destructor TUser.Destroy();
begin
  PasswordGenerator.Free();
  PasswordSaltGenerator.Free();
end;

destructor TUser.Destroy();
begin
  ActivatedInstant.ReleaseReference();
  UuidGenerator.Free();

  inherited Destroy();
end;

function TUser.EncryptPassword(const Password: TText): TText;
var
  HashAlgorithm: TMd5;
  Digest:        TMemoryBlock;
begin
  HashAlgorithm := TMd5.Create();

  PasswordSalt.Write(HashAlgorithm);
  Password.Write(HashAlgorithm);

  Digest := HashAlgorithm.Digest();
  Result := TByteBlockTextFormat.Hexadecimal.Format(Digest);

  Digest.Free();
  HashAlgorithm.Free();
end;

procedure TUser.GenerateActivationCode;
begin
  ActivationCode := UuidGenerator.Generate();
end;

{$IF not Defined(FPC)}
class function TUser.LoadFromDatabase(Database: TSqlDatabase; const Restrictions: array of TSqlExpressionBuilder): TUser;
var
  Select:      TSqlSelect;
  Restriction: TSqlExpression;
  Mapper:      TObjectRelationalMapper;
begin
  Mapper := TObjectRelationalMapper.Create(Database);

  Select := TSqlSelect.Create();
  Select.Columns.AddTableColumn(UserManagementTableSet.UsersTable.ID);
  Select.Columns.AddTableColumn(UserManagementTableSet.UsersTable.Name);
  Select.Columns.AddTableColumn(UserManagementTableSet.UsersTable.Email);
  Select.Columns.AddTableColumn(UserManagementTableSet.UsersTable.ExposeEmail);
  Select.Columns.AddTableColumn(UserManagementTableSet.UsersTable.Informed);
  Select.Columns.AddTableColumn(UserManagementTableSet.UsersTable.ConditionsAccepted);
  Select.Columns.AddTableColumn(UserManagementTableSet.UsersTable.Comments);
  Select.Columns.AddTableColumn(UserManagementTableSet.UsersTable.PasswordSalt);
  Select.Columns.AddTableColumn(UserManagementTableSet.UsersTable.EncryptedPassword);
  Select.Columns.AddTableColumn(UserManagementTableSet.UsersTable.ActivatedInstant);
  Select.From.Add(UserManagementTableSet.UsersTable.ToExpression());

  for Restriction in Restrictions do
    Select.Restrictions.Add(Restriction);

  Result := Mapper.ReadObject(TUser, Select) as TUser;
  Mapper.Free();
end;

class function TUser.LoadWithEMail(Database: TSqlDatabase; const EMail: TText): TUser;
begin
  Result := LoadFromDatabase(Database, [ UserManagementTableSet.UsersTable.Email = EMail ]);
end;

class function TUser.LoadWithIdentifier(Database: TSqlDatabase; Identifier: TUserIdentifier): TUser;
begin
  Result := LoadFromDatabase(Database, [ UserManagementTableSet.UsersTable.ID = Identifier ]);
end;

class function TUser.LoadWithBearer(Database: TSqlDatabase; const Bearer: TUuid): TUser;
begin
  Result := LoadFromDatabase(
    Database,
    [
      InSubquery(
        UserManagementTableSet.UsersTable.ID,
        Select(
          [ UserManagementTableSet.UserApplicationTable.UserID ],
          [ UserManagementTableSet.UserApplicationTable ],
          [ UserManagementTableSet.UserApplicationTable.Bearer = Deprecated_LiteralTexualUuid(Bearer) ]
        )
      )
    ]
  );
end;
{$ENDIF}

procedure TUser.SetActivatedInstant(const Value: TGregorianInstant);
begin
  if Value <> ActivatedInstant then
  begin
    Value.AddReference();
    ActivatedInstant.ReleaseReference();

    FActivatedInstant := Value;
  end;
end;

procedure TUser.SetPassword(const Password: TText);
begin
  PasswordSalt      := PasswordSaltGenerator.Generate();
  EncryptedPassword := EncryptPassword(Password);
end;

end.