-
Notifications
You must be signed in to change notification settings - Fork 7
/
Copy pathPwGroup.cs
1664 lines (1397 loc) · 47.2 KB
/
PwGroup.cs
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
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
KeePass Password Safe - The Open-Source Password Manager
Copyright (C) 2003-2017 Dominik Reichl <[email protected]>
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/
using System;
using System.Collections.Generic;
using System.Diagnostics;
using System.Text.RegularExpressions;
using KeePassLib.Collections;
using KeePassLib.Delegates;
using KeePassLib.Interfaces;
using KeePassLib.Security;
using KeePassLib.Utility;
namespace KeePassLib
{
/// <summary>
/// A group containing several password entries.
/// </summary>
public sealed class PwGroup : ITimeLogger, IStructureItem, IDeepCloneable<PwGroup>
{
public const bool DefaultAutoTypeEnabled = true;
public const bool DefaultSearchingEnabled = true;
private PwObjectList<PwGroup> m_listGroups = new PwObjectList<PwGroup>();
private PwObjectList<PwEntry> m_listEntries = new PwObjectList<PwEntry>();
private PwGroup m_pParentGroup = null;
private DateTime m_tParentGroupLastMod = PwDefs.DtDefaultNow;
private PwUuid m_uuid = PwUuid.Zero;
private string m_strName = string.Empty;
private string m_strNotes = string.Empty;
private PwIcon m_pwIcon = PwIcon.Folder;
private PwUuid m_pwCustomIconID = PwUuid.Zero;
private DateTime m_tCreation = PwDefs.DtDefaultNow;
private DateTime m_tLastMod = PwDefs.DtDefaultNow;
private DateTime m_tLastAccess = PwDefs.DtDefaultNow;
private DateTime m_tExpire = PwDefs.DtDefaultNow;
private bool m_bExpires = false;
private ulong m_uUsageCount = 0;
private bool m_bIsExpanded = true;
private bool m_bVirtual = false;
private string m_strDefaultAutoTypeSequence = string.Empty;
private bool? m_bEnableAutoType = null;
private bool? m_bEnableSearching = null;
private PwUuid m_pwLastTopVisibleEntry = PwUuid.Zero;
private StringDictionaryEx m_dCustomData = new StringDictionaryEx();
/// <summary>
/// UUID of this group.
/// </summary>
public PwUuid Uuid
{
get { return m_uuid; }
set
{
Debug.Assert(value != null); if(value == null) throw new ArgumentNullException("value");
m_uuid = value;
}
}
/// <summary>
/// The name of this group. Cannot be <c>null</c>.
/// </summary>
public string Name
{
get { return m_strName; }
set
{
Debug.Assert(value != null); if(value == null) throw new ArgumentNullException("value");
m_strName = value;
}
}
/// <summary>
/// Comments about this group. Cannot be <c>null</c>.
/// </summary>
public string Notes
{
get { return m_strNotes; }
set
{
Debug.Assert(value != null); if(value == null) throw new ArgumentNullException("value");
m_strNotes = value;
}
}
/// <summary>
/// Icon of the group.
/// </summary>
public PwIcon IconId
{
get { return m_pwIcon; }
set { m_pwIcon = value; }
}
/// <summary>
/// Get the custom icon ID. This value is 0, if no custom icon is
/// being used (i.e. the icon specified by the <c>IconID</c> property
/// should be displayed).
/// </summary>
public PwUuid CustomIconUuid
{
get { return m_pwCustomIconID; }
set
{
Debug.Assert(value != null); if(value == null) throw new ArgumentNullException("value");
m_pwCustomIconID = value;
}
}
/// <summary>
/// Reference to the group to which this group belongs. May be <c>null</c>.
/// </summary>
public PwGroup ParentGroup
{
get { return m_pParentGroup; }
// Plugins: use <c>PwGroup.AddGroup</c> instead.
internal set { Debug.Assert(value != this); m_pParentGroup = value; }
}
/// <summary>
/// The date/time when the location of the object was last changed.
/// </summary>
public DateTime LocationChanged
{
get { return m_tParentGroupLastMod; }
set { m_tParentGroupLastMod = value; }
}
/// <summary>
/// A flag that specifies if the group is shown as expanded or
/// collapsed in the user interface.
/// </summary>
public bool IsExpanded
{
get { return m_bIsExpanded; }
set { m_bIsExpanded = value; }
}
/// <summary>
/// The date/time when this group was created.
/// </summary>
public DateTime CreationTime
{
get { return m_tCreation; }
set { m_tCreation = value; }
}
/// <summary>
/// The date/time when this group was last modified.
/// </summary>
public DateTime LastModificationTime
{
get { return m_tLastMod; }
set { m_tLastMod = value; }
}
/// <summary>
/// The date/time when this group was last accessed (read).
/// </summary>
public DateTime LastAccessTime
{
get { return m_tLastAccess; }
set { m_tLastAccess = value; }
}
/// <summary>
/// The date/time when this group expires.
/// </summary>
public DateTime ExpiryTime
{
get { return m_tExpire; }
set { m_tExpire = value; }
}
/// <summary>
/// Flag that determines if the group expires.
/// </summary>
public bool Expires
{
get { return m_bExpires; }
set { m_bExpires = value; }
}
/// <summary>
/// Get or set the usage count of the group. To increase the usage
/// count by one, use the <c>Touch</c> function.
/// </summary>
public ulong UsageCount
{
get { return m_uUsageCount; }
set { m_uUsageCount = value; }
}
/// <summary>
/// Get a list of subgroups in this group.
/// </summary>
public PwObjectList<PwGroup> Groups
{
get { return m_listGroups; }
}
/// <summary>
/// Get a list of entries in this group.
/// </summary>
public PwObjectList<PwEntry> Entries
{
get { return m_listEntries; }
}
/// <summary>
/// A flag specifying whether this group is virtual or not. Virtual
/// groups can contain links to entries stored in other groups.
/// Note that this flag has to be interpreted and set by the calling
/// code; it won't prevent you from accessing and modifying the list
/// of entries in this group in any way.
/// </summary>
public bool IsVirtual
{
get { return m_bVirtual; }
set { m_bVirtual = value; }
}
/// <summary>
/// Default auto-type keystroke sequence for all entries in
/// this group. This property can be an empty string, which
/// means that the value should be inherited from the parent.
/// </summary>
public string DefaultAutoTypeSequence
{
get { return m_strDefaultAutoTypeSequence; }
set
{
Debug.Assert(value != null); if(value == null) throw new ArgumentNullException("value");
m_strDefaultAutoTypeSequence = value;
}
}
public bool? EnableAutoType
{
get { return m_bEnableAutoType; }
set { m_bEnableAutoType = value; }
}
public bool? EnableSearching
{
get { return m_bEnableSearching; }
set { m_bEnableSearching = value; }
}
public PwUuid LastTopVisibleEntry
{
get { return m_pwLastTopVisibleEntry; }
set
{
Debug.Assert(value != null); if(value == null) throw new ArgumentNullException("value");
m_pwLastTopVisibleEntry = value;
}
}
/// <summary>
/// Custom data container that can be used by plugins to store
/// own data in KeePass groups.
/// The data is stored in the encrypted part of encrypted
/// database files.
/// Use unique names for your items, e.g. "PluginName_ItemName".
/// </summary>
public StringDictionaryEx CustomData
{
get { return m_dCustomData; }
internal set
{
if(value == null) { Debug.Assert(false); throw new ArgumentNullException("value"); }
m_dCustomData = value;
}
}
public static EventHandler<ObjectTouchedEventArgs> GroupTouched;
public EventHandler<ObjectTouchedEventArgs> Touched;
/// <summary>
/// Construct a new, empty group.
/// </summary>
public PwGroup()
{
}
/// <summary>
/// Construct a new, empty group.
/// </summary>
/// <param name="bCreateNewUuid">Create a new UUID for this group.</param>
/// <param name="bSetTimes">Set creation, last access and last modification times to the current time.</param>
public PwGroup(bool bCreateNewUuid, bool bSetTimes)
{
if(bCreateNewUuid) m_uuid = new PwUuid(true);
if(bSetTimes)
{
DateTime dtNow = DateTime.UtcNow;
m_tCreation = dtNow;
m_tLastMod = dtNow;
m_tLastAccess = dtNow;
m_tParentGroupLastMod = dtNow;
}
}
/// <summary>
/// Construct a new group.
/// </summary>
/// <param name="bCreateNewUuid">Create a new UUID for this group.</param>
/// <param name="bSetTimes">Set creation, last access and last modification times to the current time.</param>
/// <param name="strName">Name of the new group.</param>
/// <param name="pwIcon">Icon of the new group.</param>
public PwGroup(bool bCreateNewUuid, bool bSetTimes, string strName, PwIcon pwIcon)
{
if(bCreateNewUuid) m_uuid = new PwUuid(true);
if(bSetTimes)
{
DateTime dtNow = DateTime.UtcNow;
m_tCreation = dtNow;
m_tLastMod = dtNow;
m_tLastAccess = dtNow;
m_tParentGroupLastMod = dtNow;
}
if(strName != null) m_strName = strName;
m_pwIcon = pwIcon;
}
#if DEBUG
// For display in debugger
public override string ToString()
{
return (@"PwGroup '" + m_strName + @"'");
}
#endif
/// <summary>
/// Deeply clone the current group. The returned group will be an exact
/// value copy of the current object (including UUID, etc.).
/// </summary>
/// <returns>Exact value copy of the current <c>PwGroup</c> object.</returns>
public PwGroup CloneDeep()
{
PwGroup pg = new PwGroup(false, false);
pg.m_uuid = m_uuid; // PwUuid is immutable
pg.m_listGroups = m_listGroups.CloneDeep();
pg.m_listEntries = m_listEntries.CloneDeep();
pg.m_pParentGroup = m_pParentGroup;
pg.m_tParentGroupLastMod = m_tParentGroupLastMod;
pg.m_strName = m_strName;
pg.m_strNotes = m_strNotes;
pg.m_pwIcon = m_pwIcon;
pg.m_pwCustomIconID = m_pwCustomIconID;
pg.m_tCreation = m_tCreation;
pg.m_tLastMod = m_tLastMod;
pg.m_tLastAccess = m_tLastAccess;
pg.m_tExpire = m_tExpire;
pg.m_bExpires = m_bExpires;
pg.m_uUsageCount = m_uUsageCount;
pg.m_bIsExpanded = m_bIsExpanded;
pg.m_bVirtual = m_bVirtual;
pg.m_strDefaultAutoTypeSequence = m_strDefaultAutoTypeSequence;
pg.m_bEnableAutoType = m_bEnableAutoType;
pg.m_bEnableSearching = m_bEnableSearching;
pg.m_pwLastTopVisibleEntry = m_pwLastTopVisibleEntry;
pg.m_dCustomData = m_dCustomData.CloneDeep();
return pg;
}
public PwGroup CloneStructure()
{
PwGroup pg = new PwGroup(false, false);
pg.m_uuid = m_uuid; // PwUuid is immutable
pg.m_tParentGroupLastMod = m_tParentGroupLastMod;
// Do not assign m_pParentGroup
foreach(PwGroup pgSub in m_listGroups)
pg.AddGroup(pgSub.CloneStructure(), true);
foreach(PwEntry peSub in m_listEntries)
pg.AddEntry(peSub.CloneStructure(), true);
return pg;
}
public bool EqualsGroup(PwGroup pg, PwCompareOptions pwOpt,
MemProtCmpMode mpCmpStr)
{
if(pg == null) { Debug.Assert(false); return false; }
bool bIgnoreLastAccess = ((pwOpt & PwCompareOptions.IgnoreLastAccess) !=
PwCompareOptions.None);
bool bIgnoreLastMod = ((pwOpt & PwCompareOptions.IgnoreLastMod) !=
PwCompareOptions.None);
if(!m_uuid.Equals(pg.m_uuid)) return false;
if((pwOpt & PwCompareOptions.IgnoreParentGroup) == PwCompareOptions.None)
{
if(m_pParentGroup != pg.m_pParentGroup) return false;
if(!bIgnoreLastMod && (m_tParentGroupLastMod != pg.m_tParentGroupLastMod))
return false;
}
if(m_strName != pg.m_strName) return false;
if(m_strNotes != pg.m_strNotes) return false;
if(m_pwIcon != pg.m_pwIcon) return false;
if(!m_pwCustomIconID.Equals(pg.m_pwCustomIconID)) return false;
if(m_tCreation != pg.m_tCreation) return false;
if(!bIgnoreLastMod && (m_tLastMod != pg.m_tLastMod)) return false;
if(!bIgnoreLastAccess && (m_tLastAccess != pg.m_tLastAccess)) return false;
if(m_tExpire != pg.m_tExpire) return false;
if(m_bExpires != pg.m_bExpires) return false;
if(!bIgnoreLastAccess && (m_uUsageCount != pg.m_uUsageCount)) return false;
// if(m_bIsExpanded != pg.m_bIsExpanded) return false;
if(m_strDefaultAutoTypeSequence != pg.m_strDefaultAutoTypeSequence) return false;
if(m_bEnableAutoType.HasValue != pg.m_bEnableAutoType.HasValue) return false;
if(m_bEnableAutoType.HasValue)
{
if(m_bEnableAutoType.Value != pg.m_bEnableAutoType.Value) return false;
}
if(m_bEnableSearching.HasValue != pg.m_bEnableSearching.HasValue) return false;
if(m_bEnableSearching.HasValue)
{
if(m_bEnableSearching.Value != pg.m_bEnableSearching.Value) return false;
}
if(!m_pwLastTopVisibleEntry.Equals(pg.m_pwLastTopVisibleEntry)) return false;
if(!m_dCustomData.Equals(pg.m_dCustomData)) return false;
if((pwOpt & PwCompareOptions.PropertiesOnly) == PwCompareOptions.None)
{
if(m_listEntries.UCount != pg.m_listEntries.UCount) return false;
for(uint u = 0; u < m_listEntries.UCount; ++u)
{
PwEntry peA = m_listEntries.GetAt(u);
PwEntry peB = pg.m_listEntries.GetAt(u);
if(!peA.EqualsEntry(peB, pwOpt, mpCmpStr)) return false;
}
if(m_listGroups.UCount != pg.m_listGroups.UCount) return false;
for(uint u = 0; u < m_listGroups.UCount; ++u)
{
PwGroup pgA = m_listGroups.GetAt(u);
PwGroup pgB = pg.m_listGroups.GetAt(u);
if(!pgA.EqualsGroup(pgB, pwOpt, mpCmpStr)) return false;
}
}
return true;
}
/// <summary>
/// Assign properties to the current group based on a template group.
/// </summary>
/// <param name="pgTemplate">Template group. Must not be <c>null</c>.</param>
/// <param name="bOnlyIfNewer">Only set the properties of the template group
/// if it is newer than the current one.</param>
/// <param name="bAssignLocationChanged">If <c>true</c>, the
/// <c>LocationChanged</c> property is copied, otherwise not.</param>
public void AssignProperties(PwGroup pgTemplate, bool bOnlyIfNewer,
bool bAssignLocationChanged)
{
Debug.Assert(pgTemplate != null); if(pgTemplate == null) throw new ArgumentNullException("pgTemplate");
if(bOnlyIfNewer && (TimeUtil.Compare(pgTemplate.m_tLastMod, m_tLastMod,
true) < 0))
return;
// Template UUID should be the same as the current one
Debug.Assert(m_uuid.Equals(pgTemplate.m_uuid));
m_uuid = pgTemplate.m_uuid;
if(bAssignLocationChanged)
m_tParentGroupLastMod = pgTemplate.m_tParentGroupLastMod;
m_strName = pgTemplate.m_strName;
m_strNotes = pgTemplate.m_strNotes;
m_pwIcon = pgTemplate.m_pwIcon;
m_pwCustomIconID = pgTemplate.m_pwCustomIconID;
m_tCreation = pgTemplate.m_tCreation;
m_tLastMod = pgTemplate.m_tLastMod;
m_tLastAccess = pgTemplate.m_tLastAccess;
m_tExpire = pgTemplate.m_tExpire;
m_bExpires = pgTemplate.m_bExpires;
m_uUsageCount = pgTemplate.m_uUsageCount;
m_strDefaultAutoTypeSequence = pgTemplate.m_strDefaultAutoTypeSequence;
m_bEnableAutoType = pgTemplate.m_bEnableAutoType;
m_bEnableSearching = pgTemplate.m_bEnableSearching;
m_pwLastTopVisibleEntry = pgTemplate.m_pwLastTopVisibleEntry;
m_dCustomData = pgTemplate.m_dCustomData.CloneDeep();
}
/// <summary>
/// Touch the group. This function updates the internal last access
/// time. If the <paramref name="bModified" /> parameter is <c>true</c>,
/// the last modification time gets updated, too.
/// </summary>
/// <param name="bModified">Modify last modification time.</param>
public void Touch(bool bModified)
{
Touch(bModified, true);
}
/// <summary>
/// Touch the group. This function updates the internal last access
/// time. If the <paramref name="bModified" /> parameter is <c>true</c>,
/// the last modification time gets updated, too.
/// </summary>
/// <param name="bModified">Modify last modification time.</param>
/// <param name="bTouchParents">If <c>true</c>, all parent objects
/// get touched, too.</param>
public void Touch(bool bModified, bool bTouchParents)
{
m_tLastAccess = DateTime.UtcNow;
++m_uUsageCount;
if(bModified) m_tLastMod = m_tLastAccess;
if(this.Touched != null)
this.Touched(this, new ObjectTouchedEventArgs(this,
bModified, bTouchParents));
if(PwGroup.GroupTouched != null)
PwGroup.GroupTouched(this, new ObjectTouchedEventArgs(this,
bModified, bTouchParents));
if(bTouchParents && (m_pParentGroup != null))
m_pParentGroup.Touch(bModified, true);
}
/// <summary>
/// Get number of groups and entries in the current group. This function
/// can also traverse through all subgroups and accumulate their counts
/// (recursive mode).
/// </summary>
/// <param name="bRecursive">If this parameter is <c>true</c>, all
/// subgroups and entries in subgroups will be counted and added to
/// the returned value. If it is <c>false</c>, only the number of
/// subgroups and entries of the current group is returned.</param>
/// <param name="uNumGroups">Number of subgroups.</param>
/// <param name="uNumEntries">Number of entries.</param>
public void GetCounts(bool bRecursive, out uint uNumGroups, out uint uNumEntries)
{
if(bRecursive)
{
uint uTotalGroups = m_listGroups.UCount;
uint uTotalEntries = m_listEntries.UCount;
uint uSubGroupCount, uSubEntryCount;
foreach(PwGroup pg in m_listGroups)
{
pg.GetCounts(true, out uSubGroupCount, out uSubEntryCount);
uTotalGroups += uSubGroupCount;
uTotalEntries += uSubEntryCount;
}
uNumGroups = uTotalGroups;
uNumEntries = uTotalEntries;
}
else // !bRecursive
{
uNumGroups = m_listGroups.UCount;
uNumEntries = m_listEntries.UCount;
}
}
public uint GetEntriesCount(bool bRecursive)
{
uint uGroups, uEntries;
GetCounts(bRecursive, out uGroups, out uEntries);
return uEntries;
}
/// <summary>
/// Traverse the group/entry tree in the current group. Various traversal
/// methods are available.
/// </summary>
/// <param name="tm">Specifies the traversal method.</param>
/// <param name="groupHandler">Function that performs an action on
/// the currently visited group (see <c>GroupHandler</c> for more).
/// This parameter may be <c>null</c>, in this case the tree is traversed but
/// you don't get notifications for each visited group.</param>
/// <param name="entryHandler">Function that performs an action on
/// the currently visited entry (see <c>EntryHandler</c> for more).
/// This parameter may be <c>null</c>.</param>
/// <returns>Returns <c>true</c> if all entries and groups have been
/// traversed. If the traversal has been canceled by one of the two
/// handlers, the return value is <c>false</c>.</returns>
public bool TraverseTree(TraversalMethod tm, GroupHandler groupHandler, EntryHandler entryHandler)
{
bool bRet = false;
switch(tm)
{
case TraversalMethod.None:
bRet = true;
break;
case TraversalMethod.PreOrder:
bRet = PreOrderTraverseTree(groupHandler, entryHandler);
break;
default:
Debug.Assert(false);
break;
}
return bRet;
}
private bool PreOrderTraverseTree(GroupHandler groupHandler, EntryHandler entryHandler)
{
if(entryHandler != null)
{
foreach(PwEntry pe in m_listEntries)
{
if(!entryHandler(pe)) return false;
}
}
foreach(PwGroup pg in m_listGroups)
{
if(groupHandler != null)
{
if(!groupHandler(pg)) return false;
}
if(!pg.PreOrderTraverseTree(groupHandler, entryHandler))
return false;
}
return true;
}
/// <summary>
/// Pack all groups into one flat linked list of references (recursively).
/// </summary>
/// <returns>Flat list of all groups.</returns>
public LinkedList<PwGroup> GetFlatGroupList()
{
LinkedList<PwGroup> list = new LinkedList<PwGroup>();
foreach(PwGroup pg in m_listGroups)
{
list.AddLast(pg);
if(pg.Groups.UCount != 0)
LinearizeGroupRecursive(list, pg, 1);
}
return list;
}
private void LinearizeGroupRecursive(LinkedList<PwGroup> list, PwGroup pg, ushort uLevel)
{
Debug.Assert(pg != null); if(pg == null) return;
foreach(PwGroup pwg in pg.Groups)
{
list.AddLast(pwg);
if(pwg.Groups.UCount != 0)
LinearizeGroupRecursive(list, pwg, (ushort)(uLevel + 1));
}
}
/// <summary>
/// Pack all entries into one flat linked list of references. Temporary
/// group IDs are assigned automatically.
/// </summary>
/// <param name="flatGroupList">A flat group list created by
/// <c>GetFlatGroupList</c>.</param>
/// <returns>Flat list of all entries.</returns>
public static LinkedList<PwEntry> GetFlatEntryList(LinkedList<PwGroup> flatGroupList)
{
Debug.Assert(flatGroupList != null); if(flatGroupList == null) return null;
LinkedList<PwEntry> list = new LinkedList<PwEntry>();
foreach(PwGroup pg in flatGroupList)
{
foreach(PwEntry pe in pg.Entries)
list.AddLast(pe);
}
return list;
}
/// <summary>
/// Enable protection of a specific string field type.
/// </summary>
/// <param name="strFieldName">Name of the string field to protect or unprotect.</param>
/// <param name="bEnable">Enable protection or not.</param>
/// <returns>Returns <c>true</c>, if the operation completed successfully,
/// otherwise <c>false</c>.</returns>
public bool EnableStringFieldProtection(string strFieldName, bool bEnable)
{
Debug.Assert(strFieldName != null);
EntryHandler eh = delegate(PwEntry pe)
{
// Enable protection of current string
pe.Strings.EnableProtection(strFieldName, bEnable);
// Do the same for all history items
foreach(PwEntry peHistory in pe.History)
{
peHistory.Strings.EnableProtection(strFieldName, bEnable);
}
return true;
};
return PreOrderTraverseTree(null, eh);
}
/// <summary>
/// Search this group and all subgroups for entries.
/// </summary>
/// <param name="sp">Specifies the search parameters.</param>
/// <param name="lResults">Entry list in which the search results
/// will be stored.</param>
public void SearchEntries(SearchParameters sp, PwObjectList<PwEntry> lResults)
{
SearchEntries(sp, lResults, null);
}
/// <summary>
/// Search this group and all subgroups for entries.
/// </summary>
/// <param name="sp">Specifies the search parameters.</param>
/// <param name="lResults">Entry list in which the search results
/// will be stored.</param>
/// <param name="slStatus">Optional status reporting object.</param>
public void SearchEntries(SearchParameters sp, PwObjectList<PwEntry> lResults,
IStatusLogger slStatus)
{
if(sp == null) { Debug.Assert(false); return; }
if(lResults == null) { Debug.Assert(false); return; }
PwObjectList<PwEntry> lCand = GetEntries(true);
DateTime dtNow = DateTime.UtcNow;
PwObjectList<PwEntry> l = new PwObjectList<PwEntry>();
foreach(PwEntry pe in lCand)
{
if(sp.RespectEntrySearchingDisabled && !pe.GetSearchingEnabled())
continue;
if(sp.ExcludeExpired && pe.Expires && (pe.ExpiryTime <= dtNow))
continue;
l.Add(pe);
}
lCand = l;
List<string> lTerms;
if(sp.RegularExpression)
{
lTerms = new List<string>();
lTerms.Add((sp.SearchString ?? string.Empty).Trim());
}
else lTerms = StrUtil.SplitSearchTerms(sp.SearchString);
// Search longer strings first (for improved performance)
lTerms.Sort(StrUtil.CompareLengthGt);
ulong uPrcEntries = 0, uTotalEntries = lCand.UCount;
SearchParameters spSub = sp.Clone();
for(int iTerm = 0; iTerm < lTerms.Count; ++iTerm)
{
// Update counters for a better state guess
if(slStatus != null)
{
ulong uRemRounds = (ulong)(lTerms.Count - iTerm);
uTotalEntries = uPrcEntries + (uRemRounds *
lCand.UCount);
}
spSub.SearchString = lTerms[iTerm]; // No trim
// spSub.RespectEntrySearchingDisabled = false; // Ignored by sub
// spSub.ExcludeExpired = false; // Ignored by sub
bool bNegate = false;
if(spSub.SearchString.StartsWith(@"-") &&
(spSub.SearchString.Length >= 2))
{
spSub.SearchString = spSub.SearchString.Substring(1);
bNegate = true;
}
l = new PwObjectList<PwEntry>();
if(!SearchEntriesSingle(lCand, spSub, l, slStatus,
ref uPrcEntries, uTotalEntries))
{
lCand.Clear();
break;
}
if(bNegate)
{
PwObjectList<PwEntry> lRem = new PwObjectList<PwEntry>();
foreach(PwEntry pe in lCand)
{
if(l.IndexOf(pe) < 0) lRem.Add(pe);
}
lCand = lRem;
}
else lCand = l;
}
Debug.Assert(lResults.UCount == 0);
lResults.Clear();
lResults.Add(lCand);
}
private static bool SearchEntriesSingle(PwObjectList<PwEntry> lSource,
SearchParameters sp, PwObjectList<PwEntry> lResults,
IStatusLogger slStatus, ref ulong uPrcEntries, ulong uTotalEntries)
{
if(lSource == null) { Debug.Assert(false); return true; }
if(sp == null) { Debug.Assert(false); return true; }
if(lResults == null) { Debug.Assert(false); return true; }
Debug.Assert(lResults.UCount == 0);
bool bTitle = sp.SearchInTitles;
bool bUserName = sp.SearchInUserNames;
bool bPassword = sp.SearchInPasswords;
bool bUrl = sp.SearchInUrls;
bool bNotes = sp.SearchInNotes;
bool bOther = sp.SearchInOther;
bool bStringName = sp.SearchInStringNames;
bool bTags = sp.SearchInTags;
bool bUuids = sp.SearchInUuids;
bool bGroupName = sp.SearchInGroupNames;
// bool bExcludeExpired = sp.ExcludeExpired;
// bool bRespectEntrySearchingDisabled = sp.RespectEntrySearchingDisabled;
Regex rx = null;
if(sp.RegularExpression)
{
RegexOptions ro = RegexOptions.None; // RegexOptions.Compiled
if((sp.ComparisonMode == StringComparison.CurrentCultureIgnoreCase) ||
#if !KeePassUAP
(sp.ComparisonMode == StringComparison.InvariantCultureIgnoreCase) ||
#endif
(sp.ComparisonMode == StringComparison.OrdinalIgnoreCase))
{
ro |= RegexOptions.IgnoreCase;
}
rx = new Regex(sp.SearchString, ro);
}
ulong uLocalPrcEntries = uPrcEntries;
if(sp.SearchString.Length == 0) lResults.Add(lSource);
else
{
foreach(PwEntry pe in lSource)
{
if(slStatus != null)
{
if(!slStatus.SetProgress((uint)((uLocalPrcEntries *
100UL) / uTotalEntries))) return false;
++uLocalPrcEntries;
}
// if(bRespectEntrySearchingDisabled && !pe.GetSearchingEnabled())
// continue;
// if(bExcludeExpired && pe.Expires && (pe.ExpiryTime <= dtNow))
// continue;
uint uInitialResults = lResults.UCount;
foreach(KeyValuePair<string, ProtectedString> kvp in pe.Strings)
{
string strKey = kvp.Key;
if(strKey == PwDefs.TitleField)
{
if(bTitle) SearchEvalAdd(sp, kvp.Value.ReadString(),
rx, pe, lResults);
}
else if(strKey == PwDefs.UserNameField)
{
if(bUserName) SearchEvalAdd(sp, kvp.Value.ReadString(),
rx, pe, lResults);
}
else if(strKey == PwDefs.PasswordField)
{
if(bPassword) SearchEvalAdd(sp, kvp.Value.ReadString(),
rx, pe, lResults);
}
else if(strKey == PwDefs.UrlField)
{
if(bUrl) SearchEvalAdd(sp, kvp.Value.ReadString(),
rx, pe, lResults);
}
else if(strKey == PwDefs.NotesField)
{
if(bNotes) SearchEvalAdd(sp, kvp.Value.ReadString(),
rx, pe, lResults);
}
else if(bOther)
SearchEvalAdd(sp, kvp.Value.ReadString(),
rx, pe, lResults);
// An entry can match only once => break if we have added it
if(lResults.UCount != uInitialResults) break;
}
if(bStringName)
{
foreach(KeyValuePair<string, ProtectedString> kvp in pe.Strings)
{
if(lResults.UCount != uInitialResults) break;
SearchEvalAdd(sp, kvp.Key, rx, pe, lResults);
}
}
if(bTags)
{
foreach(string strTag in pe.Tags)
{
if(lResults.UCount != uInitialResults) break;
SearchEvalAdd(sp, strTag, rx, pe, lResults);
}
}
if(bUuids && (lResults.UCount == uInitialResults))
SearchEvalAdd(sp, pe.Uuid.ToHexString(), rx, pe, lResults);
if(bGroupName && (lResults.UCount == uInitialResults) &&
(pe.ParentGroup != null))
SearchEvalAdd(sp, pe.ParentGroup.Name, rx, pe, lResults);
}
}
uPrcEntries = uLocalPrcEntries;
return true;
}
private static void SearchEvalAdd(SearchParameters sp, string strData,
Regex rx, PwEntry pe, PwObjectList<PwEntry> lResults)
{
if(sp == null) { Debug.Assert(false); return; }
if(strData == null) { Debug.Assert(false); return; }