mirror of https://github.com/OpenIdentityPlatform/OpenDJ.git

andrug
28.00.2008 10f74c7682e52c5caf4ea8232ea2f0b3be455e19
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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
#!/usr/bin/python
 
# CDDL HEADER START
#
# The contents of this file are subject to the terms of the
# Common Development and Distribution License, Version 1.0 only
# (the "License").  You may not use this file except in compliance
# with the License.
#
# You can obtain a copy of the license at
# trunk/opends/resource/legal-notices/OpenDS.LICENSE
# or https://OpenDS.dev.java.net/OpenDS.LICENSE.
# See the License for the specific language governing permissions
# and limitations under the License.
#
# When distributing Covered Code, include this CDDL HEADER in each
# file and include the License file at
# trunk/opends/resource/legal-notices/OpenDS.LICENSE.  If applicable,
# add the following below this CDDL HEADER, with the fields enclosed
# information:
#      Portions Copyright [yyyy] [name of copyright owner]
#
# CDDL HEADER END
#
#
#      Copyright 2008 Sun Microsystems, Inc.
 
 
from java.io import File
from java.io import StringReader
from org.xml.sax import InputSource
from org.xml.sax import SAXParseException
from org.xml.sax.helpers import DefaultHandler
from javax.xml.parsers import DocumentBuilderFactory
from javax.xml.parsers import DocumentBuilder
from org.w3c.dom import Document
from org.w3c.dom import Element
from org.w3c.dom import Node
from org.w3c.dom import NodeList
 
 
#============================================================================
#
# GLOBAL VARIABLES
# Warning : some of global variables are also defined in main_run.xml file
 
NOT_DEFINED = 'ERROR_not_defined'
TRUE = 0
FALSE = 1
 
#============================================================================
#
# CLASS DEFINITION
 
 
#
# Class for suffix
#
 
###########################
class Scenario:
  "Describes the scenario main informations"
  def __init__(self, name, description):
    self.name         = name
    self.description  = description
    self.durationUnit = NOT_DEFINED
    self.durationTime = NOT_DEFINED
    
  def getName(self):
    return self.name
    
  def getDescription(self):
    return self.description
    
  def getDurationUnit(self):
    return self.durationUnit
    
  def setDurationUnit(self,durationUnit):
    self.durationUnit = durationUnit
    
  def getDurationTime(self):
    return self.durationTime
    
  def setDurationTime(self,durationTime):
    self.durationTime = durationTime
 
 
###########################
class SubordinateTemplate:
  "Describes entry data information for ldif file"
  def __init__(self, cType, cNb):
    self.cType = cType
    self.cNb   = cNb
    
  def getType(self):
    return self.cType
    
  def getNb(self):
    return self.cNb
 
 
###########################
class Branch:
  """Describes branch data information for ldif file :
   [name, [list_of_branch], [list_of_leaf]]"""
  def __init__(self, name, subtrees, subordinateTemplates):
    self.name = name
    self.subtrees = subtrees
    self.subordinateTemplates = subordinateTemplates
  
  def getName(self):
    return self.name
    
  def getSubtrees(self):
    return self.subtrees
    
  def getSubordinateTemplates(self):
    return self.subordinateTemplates
 
 
###########################
class SuffixTopology:
  "Describes the topology (list of instances,..) of a suffix"
  def __init__(self, name, initRule, instanceSourceName):
    self.name               = name
    self.initRule           = initRule
    self.instanceSourceName = instanceSourceName
    self.instanceRef        = NOT_DEFINED
    
  def getName(self):
    return self.name
    
  def getInstanceRef(self):
    return self.instanceRef
    
  def setInstanceRef(self,instanceRef):
    self.instanceRef = instanceRef
    
  def getInitRule(self):
    return self.initRule
    
  def getInstanceSourceName(self):
    return self.instanceSourceName
 
 
###########################
class Suffix:
  """Describes suffix information, 
   tree is a list of Branch objectclasses
   topology is a list of SuffixTopology objectclasses"""
  def __init__(self, sid, dn, topology, nbOfEntries, tree):
    self.sid         = sid
    self.dn          = dn
    self.topology    = topology
    self.nbOfEntries = nbOfEntries
    self.tree        = tree
  
  def getId(self):
    return self.sid
    
  def getSuffixDn(self):
    return self.dn
    
  def getTopology(self):
    return self.topology
    
  def setTopology(self,topology):
    self.topology = topology
    
  def getElementFromTopology(self, instanceName):
    "Return the instance objectclass of the instance name given in parameter"
    found = FALSE
    for cElement in self.topology:
      if cElement.getName() == instanceName:
        found = TRUE
        break
    return [found,cElement]
    
  def getNbOfEntries(self):
    return self.nbOfEntries
    
  def getTree(self):
    return self.tree
 
 
#
# Class for instance 
#
 
###########################
class Instance:
  "Describes a generic LDAP instance"
  def __init__(self, iid, name, host, installDir, tarball, portLDAP):
    self.iid         = iid
    self.name        = name
    self.host        = host
    self.installDir  = installDir
    self.tarball     = tarball
    self.portLDAP    = portLDAP
    self.os          = NOT_DEFINED
    self.buildId     = NOT_DEFINED
    self.binDir      = NOT_DEFINED
    self.synchroDate = NOT_DEFINED
    
  def getId(self):
    return self.iid
    
  def setId(self,iid):
    self.iid = iid
    
  def getName(self):
    return self.name
    
  def getHost(self):
    return self.host
    
  def setHost(self,host):
    self.host = host
    
  def getInstallDir(self):
    return self.installDir
    
  def getTarball(self):
    return self.tarball
    
  def getLDAPPort(self):
    return self.portLDAP
    
  def getOs(self):
    return self.os
    
  def setOs(self,os):
    self.os = os
    
  def getBuildId(self):
    return self.buildId
    
  def setBuildId(self,buildId):
    self.buildId = buildId
    
  def getBinDir(self):
    return self.binDir
    
  def setBinDir(self,binDir):
    self.binDir = binDir
    
  def getSynchroDate(self):
    return self.synchroDate
    
  def setSynchroDate(self,synchroDate):
    self.synchroDate = synchroDate
 
 
###########################
class OpendsInstance(Instance):
  "Describes an opends Instance"
  def __init__(self, iid, name, host, installDir, tarball, portLDAP, \
               product, portLDAPS, portJMX, portREPL):
    self.iid         = iid
    self.name        = name
    self.product     = product
    self.host        = host
    self.installDir  = installDir
    self.tarball     = tarball
    self.portLDAP    = portLDAP
    self.portLDAPS   = portLDAPS
    self.portJMX     = portJMX
    self.portREPL    = portREPL
    self.javaVersion = NOT_DEFINED
    
  def getProduct(self):
    return self.product
    
  def getLDAPSPort(self):
    return self.portLDAPS
    
  def getJMXPort(self):
    return self.portJMX
    
  def getREPLPort(self):
    return self.portREPL
    
  def getJavaVersion(self):
    return self.javaVersion
    
  def setJavaVersion(self,javaVersion):
    self.javaVersion = javaVersion
 
 
 
#
# Class for client
#
 
###########################
class Client:
  "Describes a ldap client"
  def __init__(self, iid, name, host, params):
    self.iid        = iid
    self.name       = name
    self.host       = host
    self.params     = params
    self.start      = NOT_DEFINED
    self.stop       = NOT_DEFINED
    self.dependency = NOT_DEFINED
    self.result     = NOT_DEFINED
    
  def getId(self):
    return self.iid
    
  def getName(self):
    return self.name
    
  def getHost(self):
    return self.host
    
  def getParams(self):
    return self.params
    
  def getStart(self):
    return self.start
    
  def setStart(self,start):
    self.start = start
    
  def getStop(self):
    return self.stop
    
  def setStop(self,stop):
    self.stop = stop
    
  def getDependency(self):
    return self.dependency
    
  def setDependency(self,dependency):
    self.dependency = dependency
    
  def getResult(self):
    return self.result
    
  def setResult(self,result):
    self.result = result
 
 
###########################
class Module:
  "Describes a module that contains clients"
  def __init__(self, name, enabled, clients):
    self.name    = name
    self.enabled = enabled
    self.clients = clients
    
  def getName(self):
    return self.name
    
  def getEnabled(self):
    return self.enabled
    
  def getClients(self):
    return self.clients
 
 
#============================================================================
#
# FUNCTIONS
#
 
def getRefObjectByName(myName,myList):
  """This function returns the reference of a object specified 
     by myName if it exist in myList"""
  found = FALSE
  msg = ''
  for myObject in myList:
    if myObject.getName() == myName:
      found = TRUE
      break
  if found == FALSE:
    msg = 'ERROR, getRefObjectByName(): cant find object reference for name %s'%\
          myName
  return [msg,myObject]
 
 
def _getPropValue(myNode):
  "This function get the first node text value of a node"
  propValueNode = myNode.getFirstChild()
  if (propValueNode.getNodeType() == Node.TEXT_NODE or
      propValueNode.getNodeType() == Node.COMMENT_NODE):
    #out = '%s' % (myNode.getNodeName())
    out = '%s' % (propValueNode.getNodeValue())
  else:
    out = 'ERROR %s has not a text children node type, should be' % \
          (myNode.getNodeName())
  return out
 
def _getAttributeNode(myNode,myAttributeName):
  cAttrNodes = myNode.getAttributes()
  cAttrNode = cAttrNodes.getNamedItem(myAttributeName)
  if (myNode.hasAttributes() and cAttrNode != None):
    cAttrValue = cAttrNode.getNodeValue()
  else:
    cAttrValue = NOT_DEFINED
  return cAttrValue
 
 
 
#============================================================================
#
# PARSER
#
def main(document):
  
  #document = STAXResult
  
  # Change code here to parse the document as you desire.
  # The code shown here is just an example for parsing a STAX xml document
  
  root = document.getDocumentElement()
  children = root.getChildNodes()
  
  msg              = ''
  globalParameters = []
  instances        = []
  suffix           = []
  clientPhases     = []
  cId              = 0
  
  for i in range(children.getLength()):
    cId += 1
    thisChild = children.item(i)
    
    #
    # Parsing global parameters node
    #
    if (thisChild.getNodeType() == Node.ELEMENT_NODE and
        thisChild.getNodeName() == 'globalParameters'):
      
      result = parseGlobalParameters(thisChild)
      msg = '%s \n %s' % (msg,result[0])
      scenario   = result[1]
      opendsName = result[2]
      opendsZip  = result[3]
      domain     = result[4]
    
    #
    # Parsing instance node
    #
    elif (thisChild.getNodeType() == Node.ELEMENT_NODE and
        thisChild.getNodeName() == 'instance'):
      
      cName = _getAttributeNode(thisChild,'name')
      if cName == NOT_DEFINED:
        msg = '%s\n ERROR: cant get instance name attribute, required' % msg
        return [msg,[],[]]
      cProduct = _getAttributeNode(thisChild,'product')
      if cProduct == NOT_DEFINED:
        msg = '%s\n ERROR: cant get instance product attribute, required'% msg
        return [msg,[],[]]
      
      #
      # opends instance parsing
      #
      if cProduct == 'opends':
        result = parseOpenDs(cId,cName,cProduct,opendsName,opendsZip,thisChild)
        msg = '%s \n %s' % (msg,result[0])
        instances.append(result[1])
      
      else:
        msg = '%s\n ERROR: unknown product %s' % (msg, cProduct)
    
    
    #
    # Parsing suffix node
    #
    elif (thisChild.getNodeType() == Node.ELEMENT_NODE and
        thisChild.getNodeName() == 'suffix'):
      
      cSuffixName = _getAttributeNode(thisChild,'dn')
      
      result = parseSuffix(cId,cSuffixName,thisChild)
      msg = '%s \n %s' % (msg,result[0])
      # restriction 1 suffix node
      suffix = result[1]
    
    
    #
    # Parsing scheduler node : should be only one node
    #
    elif (thisChild.getNodeType() == Node.ELEMENT_NODE and
        thisChild.getNodeName() == 'scheduler'):
      
      result       = parseScheduler(thisChild)
      msg          = '%s \n %s' % (msg,result[0])
      phases       = result[1]
      durationUnit = result[2]
      durationTime = result[3]
    
    
    #
    # Parsing other nodes...
    #
    elif thisChild.getNodeType() == Node.COMMENT_NODE:
      # Do nothing
      continue
    
    elif thisChild.getNodeType() == Node.ELEMENT_NODE:
      msg = '%s\n Found %s element' % (msg, thisChild.getNodeName())
  
  
  # End of parsing
  
  
  #
  # Set duration time and unit to scenario object
  #
  scenario.setDurationTime(durationTime)
  scenario.setDurationUnit(durationUnit)
  
  #
  # Set replication server host/port/installdir used by this suffix
  #
  for cSuffixInstance in suffix.getTopology():
    for cInstance in instances:
      if cInstance.getName() == cSuffixInstance.getName():
        cSuffixInstance.setInstanceRef(cInstance)
      
  return [msg,instances,suffix,phases,scenario,domain]
  # end of main function  
  
  
  
  
#============================================================================
#
# Parse children and get information for opends instance 
#
def parseOpenDs(cId,cName,cProduct,opendsName,opendsZip,thisChild):
  msg         = ''
  cHost       = 'localhost'
  cInstallDir = NOT_DEFINED
  cPortLDAP   = '1389'
  cPortLDAPS  = '1636'
  cPortJMX    = '1390'
  cPortREPL   = '1391'
  
  #
  # Parsing second level : host,ports,...
  #
  if thisChild.hasChildNodes():
    
    subChildren = thisChild.getChildNodes()
    
    for j in range(subChildren.getLength()):
      
      thisSubChild = subChildren.item(j)
      
      if (thisSubChild.getNodeType() == Node.ELEMENT_NODE and
          thisSubChild.getNodeName() == 'host'):
        cHost = _getPropValue(thisSubChild)
        
      elif (thisSubChild.getNodeType() == Node.ELEMENT_NODE and
          thisSubChild.getNodeName() == 'installDir'):
        cInstallDir = _getPropValue(thisSubChild)
        
      elif (thisSubChild.getNodeType() == Node.ELEMENT_NODE and
          thisSubChild.getNodeName() == 'ports'):
          
        # Get instance port values
        if thisSubChild.hasChildNodes():
          portList = thisSubChild.getChildNodes()
          for k in range(portList.getLength()):
            thisPort = portList.item(k)
            if (thisPort.getNodeType() == Node.ELEMENT_NODE and
                thisPort.getNodeName() == 'ldap'):
              cPortLDAP = _getPropValue(thisPort)
            elif (thisPort.getNodeType() == Node.ELEMENT_NODE and
                thisPort.getNodeName() == 'ldaps'):
              cPortLDAPS = _getPropValue(thisPort)
            elif (thisPort.getNodeType() == Node.ELEMENT_NODE and
                thisPort.getNodeName() == 'jmx'):
              cPortJMX = _getPropValue(thisPort)
            elif (thisPort.getNodeType() == Node.ELEMENT_NODE and
                thisPort.getNodeName() == 'replicationServer'):
              cPortREPL = _getPropValue(thisPort)
            # must be at the end of the if case
            elif (thisPort.getNodeType() == Node.TEXT_NODE or
                  thisPort.getNodeType() == Node.COMMENT_NODE):
              # text node information,skip, no need
              continue
            else:
              msg = '%s\n ERROR: instance %s : unknown port node name %s' % \
                    (msg, cName, thisPort.getNodeName())
            
      
      # must be at the end of the if case
      elif (thisSubChild.getNodeType() == Node.TEXT_NODE or
            thisSubChild.getNodeType() == Node.COMMENT_NODE):
        # text node information,skip, no need
        continue
      else:
        msg = '%s\n ERROR: instance %s : unknown instance property named %s' %\
              (msg, cName, thisSubChild.getNodeName())
        
    # end for
  #
  # no second level
  #
  else:
    msg = '%s\n ERROR: instance %s : no children for instance node' % \
          (msg,cName)
  
  cInstallDir = '%s/%s/%s' % (cInstallDir,cName,opendsName)
  return [msg,OpendsInstance(cId,cName,cHost,cInstallDir,opendsZip,cPortLDAP,\
                             cProduct,cPortLDAPS,cPortJMX,cPortREPL)]
 
 
#============================================================================
#
# Parse children and get information for suffix node 
#
def parseSuffix(cId,cSuffixName,thisChild):
  msg                = ''
  cSuffixReplServers = NOT_DEFINED
  cNbOfEntries       = NOT_DEFINED
  
  #
  # Parsing second level : instanceList,numberOfEntries,...
  #
  if thisChild.hasChildNodes():
 
    subChildren = thisChild.getChildNodes()
 
    for j in range(subChildren.getLength()):
    
      cInstanceSourceName = NOT_DEFINED
      thisSubChild = subChildren.item(j)
        
      if (thisSubChild.getNodeType() == Node.ELEMENT_NODE and
          thisSubChild.getNodeName() == 'topology'):
        
        cSuffixReplServers = []
        
        # Get instance names
        if thisSubChild.hasChildNodes():
          instanceList = thisSubChild.getChildNodes()
          for k in range(instanceList.getLength()):
            thisInstance = instanceList.item(k)
            
            if (thisInstance.getNodeType() == Node.ELEMENT_NODE and
                thisInstance.getNodeName() == 'element'):
              cInstanceName = _getAttributeNode(thisInstance,'instanceName')
              cInstanceInitRule = _getAttributeNode(thisInstance,'initRule')
              cInstanceSourceName = _getAttributeNode(thisInstance, \
                                                      'instanceSourceName')
              if cInstanceInitRule.lower() == "totalupdate":
                if cInstanceSourceName == NOT_DEFINED:
                  msg = '%s\n ERROR: parseSuffix(): initRule=totalUpdate' % msg
                  msg = '%s, and should have also instanceSource attribute'%msg
                  msg = '%s which has been not found' % msg
              cSuffixReplServers.append(SuffixTopology(cInstanceName,\
                                                       cInstanceInitRule,\
                                                       cInstanceSourceName))
              
            # must be at the end of the if case
            elif (thisInstance.getNodeType() == Node.TEXT_NODE or
                  thisInstance.getNodeType() == Node.COMMENT_NODE):
              # text node information,skip, no need
              continue
            else:
              msg = '%s\n ERROR: parseSuffix(): unknown node named %s' % \
                    (msg, thisInstance.getNodeName())
              
        else:
          msg = '%s\n ERROR: parseSuffix(): %s node should have child node %s'%\
                (msg,thisSubChild.getNodeName())
          
      elif (thisSubChild.getNodeType() == Node.ELEMENT_NODE and
            thisSubChild.getNodeName() == 'numberOfEntries'):
        cNbOfEntries = _getPropValue(thisSubChild)
        
      # parsing suffix TREE
      elif (thisSubChild.getNodeType() == Node.ELEMENT_NODE and
            thisSubChild.getNodeName() == 'tree'):
        
        if thisSubChild.hasChildNodes():
          cNbOfEntries = _getAttributeNode(thisSubChild,'nbOfEntries')
          cResult = getSuffixTree('root',cNbOfEntries,thisSubChild)
          cBranches = cResult[1]
          msg = '%s\n%s' % (msg,cResult[0])
          
        else:
          msg = '%s\n ERROR: parseSuffix(): %s node should have child node %s'%\
                (msg,thisSubChild.getNodeName())
          
          
      # must be at the end of the if case
      elif (thisSubChild.getNodeType() == Node.TEXT_NODE or
            thisSubChild.getNodeType() == Node.COMMENT_NODE):
        # text node information,skip, no need
        continue
      else:
        msg = '%s\n ERROR: parseSuffix(): unknown suffix property named %s' % \
              (msg, thisSubChild.getNodeName())
      
  #
  # no subchildren for suffix node
  #
  else:
    msg = '%s\n ERROR: parseSuffix() : no children for suffix node' % msg
  
  return [msg,Suffix(cId,cSuffixName,cSuffixReplServers,cNbOfEntries,cBranches)]
  
  
  
#============================================================================
#
# Get tree information 
# a branch has :
#   a name
#   some branches (0 or more)
#   some subordinateTemplate (0 or more)
def getSuffixTree(cBranchName,nbOfEntries,cNode):
  msg = ''
  # cSubordinateTemplates is a list of subordinateTemplates a node can have
  cSubordinateTemplates = []
  # cBranches is a list of branches a node can have
  cBranches = []
  nodeList = cNode.getChildNodes()
  
  for n in range(nodeList.getLength()):
    
    thisNode = nodeList.item(n)
    
    if (thisNode.getNodeType() == Node.ELEMENT_NODE and
        thisNode.getNodeName() == 'branch'):
      
      cResult = getSuffixTree(_getAttributeNode(thisNode,'name'),\
                              nbOfEntries,thisNode)
      cBranches.append(cResult[1])
      msg = '%s\n%s' % (msg,cResult[0])
      
    # get subordinateTemplate if exist
    # if percentage, calculate the nb of entries, 
    # else get nb of entries directly
    elif (thisNode.getNodeType() == Node.ELEMENT_NODE and
          thisNode.getNodeName() == 'subordinateTemplate'):
      cPerc = NOT_DEFINED
      cType = _getAttributeNode(thisNode,'type')
      cPerc = _getAttributeNode(thisNode,'percentage')
      if cPerc != NOT_DEFINED:
        cPerc = (int(cPerc) * int(nbOfEntries)) / 100
      else:
        cPerc = _getAttributeNode(thisNode,'nb')
      cSubordinateTemplates.append(SubordinateTemplate(cType,cPerc))
      
    # must be at the end of the if case
    elif (thisNode.getNodeType() == Node.TEXT_NODE or
          thisNode.getNodeType() == Node.COMMENT_NODE):
      # text node information,skip, no need
      continue
    else:
      msg = '%s\n ERROR: getSuffixTree() : unknown node named %s' % \
            (msg, thisNode.getNodeName())
      
  if cBranches == []:
    cBranches = [NOT_DEFINED]
  if cSubordinateTemplates == []:
    cSubordinateTemplates = [NOT_DEFINED]
  
  return [msg,Branch(cBranchName,cBranches,cSubordinateTemplates)]
 
 
 
#============================================================================
#
# displayTree : display the data tree of a suffix with XML format
def getSuffixDataForXML(suffixName,cBranch):
  msg         = ''
  cBranchName = cBranch.getName()
  if cBranchName == 'root':
    msg = "%s\n <tree>" % msg
  else:
    msg = "%s\n <branch name=\"%s\">" %(msg,cBranchName)
  
  # leaf
  cLeafs = cBranch.getSubordinateTemplates()
  if (cLeafs[0] != NOT_DEFINED):
    for cLeaf in cLeafs:
      msg = '%s\n<subordinateTemplate type=\"%s\"' % (msg,cLeaf.getType())
      msg = '%s nb=\"%s\"></subordinateTemplate>'  % (msg,cLeaf.getNb())
  # subBranches
  subBranches = cBranch.getSubtrees()
  if subBranches[0] != NOT_DEFINED:
    for cSubBranch in subBranches:
      msg = '%s\n%s' % (msg,getSuffixDataForXML(suffixName,cSubBranch))
  
  
  if cBranchName == 'root':
    msg = "%s\n </tree>" % msg
  else:
    msg = "%s\n </branch>" % msg
  
  return msg
 
 
#============================================================================
#
# getSuffixDataForMakeLDIF : display the data tree of a suffix 
# using makedlif format
def getSuffixDataForMakeLDIF(suffixName,nbOfEntries,cBranch):
  msg = ''
  cBranchName = cBranch.getName()
  if cBranchName == 'root':
    cBranchName = suffixName
  
  msg = "%s\nbranch: %s " % (msg,cBranchName)
  
  # leaf
  cLeafs = cBranch.getSubordinateTemplates()
  if (cLeafs[0] != NOT_DEFINED):
    for cLeaf in cLeafs:
      msg = '%s\nsubordinateTemplate: %s:%s' % (msg,cLeaf.getType(), \
                                                cLeaf.getNb())
  
  # subBranches
  subBranches = cBranch.getSubtrees()
  if subBranches[0] != NOT_DEFINED:
    for cSubBranch in subBranches:
      msg = '%s\n%s' % (msg,\
            getSuffixDataForMakeLDIF(suffixName,nbOfEntries,cSubBranch))
  
  return msg
 
 
 
#============================================================================
#
# Parse children and get information for scheduler node 
#
def parseScheduler(thisChild):
  msg = ''
  scheduler = []
  
  #
  # Parsing second level : duration,module,...
  #
  if thisChild.hasChildNodes():
    
    subChildren = thisChild.getChildNodes()
    
    for j in range(subChildren.getLength()):
      
      cClients = NOT_DEFINED
      thisSubChild = subChildren.item(j)
      
      if (thisSubChild.getNodeType() == Node.ELEMENT_NODE and
          thisSubChild.getNodeName() == 'duration'):
        
        durationUnit = _getAttributeNode(thisSubChild,'unit')
        durationTime = _getPropValue(thisSubChild)
        
      elif (thisSubChild.getNodeType() == Node.ELEMENT_NODE and
          thisSubChild.getNodeName() == 'module'):
        
        cClients = []
        cModuleName = _getAttributeNode(thisSubChild,'name')
        cModuleEnabled = _getAttributeNode(thisSubChild,'enabled')
        
        result = parseClients(thisSubChild)
        msg = '%s \n %s' % (msg,result[0])
        cClients = result[1]
        
        scheduler.append(Module(cModuleName,cModuleEnabled,cClients))
        
      # must be at the end of the if case
      elif (thisSubChild.getNodeType() == Node.TEXT_NODE or
            thisSubChild.getNodeType() == Node.COMMENT_NODE):
        # text node information,skip, no need
        continue
      else:
        msg = '%s\n ERROR: parseScheduler() : unknown property named %s' % \
              (msg, thisSubChild.getNodeName())
  
  #
  # no subchildren
  #
  else:
    msg = '%s\n ERROR: parseScheduler() : no children for scheduler node' % msg
  
  return [msg,scheduler,durationUnit,durationTime]
 
 
 
#============================================================================
#
# Parse children and get information for a list of clients 
#
def parseClients(thisChild):
  msg = ''
  clients = []
  
  #
  # Parsing second level : phase,...
  #
  if thisChild.hasChildNodes():
    
    subChildren = thisChild.getChildNodes()
    
    for j in range(subChildren.getLength()):
    
      thisSubChild = subChildren.item(j)
      
      if (thisSubChild.getNodeType() == Node.ELEMENT_NODE and
          thisSubChild.getNodeName() == 'client'):
        
        name       = NOT_DEFINED
        host       = NOT_DEFINED
        start      = NOT_DEFINED
        stop       = NOT_DEFINED
        dependency = NOT_DEFINED
        clientId   = NOT_DEFINED
        params     = []
        
        name       = _getAttributeNode(thisSubChild,'name')
        host       = _getAttributeNode(thisSubChild,'host')
        start      = _getAttributeNode(thisSubChild,'start')
        stop       = _getAttributeNode(thisSubChild,'stop')
        dependency = _getAttributeNode(thisSubChild,'dependencyId')
        clientId   = _getAttributeNode(thisSubChild,'id')
        
        # Get phase sub-nodes information
        if thisSubChild.hasChildNodes():
          nodeList = thisSubChild.getChildNodes()
          for k in range(nodeList.getLength()):
            thisNode = nodeList.item(k)
            
            if (thisNode.getNodeType() == Node.ELEMENT_NODE):
              param = [ thisNode.getNodeName(), _getPropValue(thisNode) ]
              params.append(param)
            
            # must be at the end of the if case
            elif (thisNode.getNodeType() == Node.TEXT_NODE or
                  thisNode.getNodeType() == Node.COMMENT_NODE):
              # text node information,skip, no need
              continue
            else:
              msg = '%s\n ERROR: parseClients(): unknown node named %s' % \
                    (msg, thisNode.getNodeName())
          
        else:
          msg = '%s\n ERROR: parseClients(): %s node should have child %s' % \
                (msg,thisSubChild.getNodeName())
        
        cClient = Client(clientId,name,host,params)
        if (start == NOT_DEFINED):
          msg = '%s\n ERROR: parseClients(): client %s:' % (msg,name)
          msg = '%s start attribute required' % msg
        else:
          cClient.setStart(start)
        if (stop != NOT_DEFINED):
          cClient.setStop(stop)
        if (dependency != NOT_DEFINED):
          cClient.setDependency(dependency)
        
        clients.append(cClient)
        
      # must be at the end of the if case
      elif (thisSubChild.getNodeType() == Node.TEXT_NODE or
            thisSubChild.getNodeType() == Node.COMMENT_NODE):
        # text node information,skip, no need
        continue
      else:
        msg = '%s\n ERROR: parseClients() : unknown property named %s' % \
              (msg, thisSubChild.getNodeName())
      
  #
  # no subchildren for suffix node
  #
  else:
    msg = '%s\n ERROR: parseClients() : no children for clients node' % (msg)
  
  return [msg,clients]
 
 
 
#============================================================================
#
# Parse global parameters node 
#
def parseGlobalParameters(thisChild):
  msg        = ''
  result     = []
  scenario   = NOT_DEFINED
  opendsName = NOT_DEFINED
  opendsZip  = NOT_DEFINED
  domain     = NOT_DEFINED
  
  #
  # Parsing second level : opendsName,...
  #
  if thisChild.hasChildNodes():
    
    subChildren = thisChild.getChildNodes()
    
    for j in range(subChildren.getLength()):
    
      thisSubChild = subChildren.item(j)
      
      if (thisSubChild.getNodeType() == Node.ELEMENT_NODE and
          thisSubChild.getNodeName() == 'opendsName'):
        opendsName = _getPropValue(thisSubChild)
        
      elif (thisSubChild.getNodeType() == Node.ELEMENT_NODE and
          thisSubChild.getNodeName() == 'opendsZip'):
        opendsZip = _getPropValue(thisSubChild)
        
      elif (thisSubChild.getNodeType() == Node.ELEMENT_NODE and
          thisSubChild.getNodeName() == 'domain'):
        domain = _getPropValue(thisSubChild)
        
      elif (thisSubChild.getNodeType() == Node.ELEMENT_NODE and
          thisSubChild.getNodeName() == 'scenario'):
        cResult = parseScenario(thisSubChild)
        scenario = cResult[1]
        msg = '%s\n%s' % (msg,cResult[0])
      
      
      # must be at the end of the if case
      elif (thisSubChild.getNodeType() == Node.TEXT_NODE or
            thisSubChild.getNodeType() == Node.COMMENT_NODE):
        # text node information,skip, no need
        continue
      else:
        msg = '%s\n ERROR: parseGlobalParameters(): unknown node named %s' % \
              (msg, thisSubChild.getNodeName())
        
  #
  # no subchildren for globalParameters node
  #
  else:
    msg = '%s\n ERROR: parseGlobalParameters(): no child for this node' % msg
    
    
  if (opendsName == NOT_DEFINED):
    msg = '%s\n ERROR: parseGlobalParameters() : opendsName not defined' % (msg)
  if (opendsZip == NOT_DEFINED):
    msg = '%s\n ERROR: parseGlobalParameters() : opendsZip not defined' % (msg)
 
  return [msg,scenario,opendsName,opendsZip,domain]
 
 
 
#============================================================================
#
# Parse global parameters node 
#
def parseScenario(thisChild):
  preMsg      = 'ERROR: parseGlobalParameters():'
  msg         = ''
  result      = []
  name        = NOT_DEFINED
  description = NOT_DEFINED
  
  #
  # Parsing second level : opendsName,...
  #
  if thisChild.hasChildNodes():
    
    subChildren = thisChild.getChildNodes()
    
    for j in range(subChildren.getLength()):
    
      thisSubChild = subChildren.item(j)
      
      if (thisSubChild.getNodeType() == Node.ELEMENT_NODE and
          thisSubChild.getNodeName() == 'name'):
        name = _getPropValue(thisSubChild)
        
      elif (thisSubChild.getNodeType() == Node.ELEMENT_NODE and
          thisSubChild.getNodeName() == 'description'):
        description = _getPropValue(thisSubChild)
        
      
      # must be at the end of the if case
      elif (thisSubChild.getNodeType() == Node.TEXT_NODE or
            thisSubChild.getNodeType() == Node.COMMENT_NODE):
        # text node information,skip, no need
        continue
      else:
        msg = '%s\n ERROR: parseGlobalParameters(): unknown node named %s' % \
              (msg, thisSubChild.getNodeName())
        
  #
  # no subchildren for globalParameters node
  #
  else:
    msg = '%s\n %s no child for this node' % (preMsg,msg)
    
    
  if (name == NOT_DEFINED):
    msg = '%s\n %s scenario name not defined' % (preMsg,msg)
  if (description == NOT_DEFINED):
    msg = '%s\n %s scenario description not defined' % (preMsg,msg)
 
  return [msg,Scenario(name,description)]