home *** CD-ROM | disk | FTP | other *** search
/ PC World 2000 December / PCWorld_2000-12_cd.bin / Komunikace / Comanche / plugins / apache / apacheModuleManager.tcl < prev    next >
Text File  |  2000-11-02  |  5KB  |  170 lines
  1. #
  2. # apacheModuleManager.tcl --
  3. #
  4. #  The apacheModuleManager manages information about
  5. # different aspects of apache modules, as described in apacheModuleFormat.txt
  6. # in the docs directory.
  7. #  The apacheModuleManager has one propertyPagesManager per module, and keeps
  8. # track internally of which property pages belong to which modules.
  9. #   Things that apacheModuleManager allows:
  10. #   
  11. #   - Enable/disable modules on the fly
  12. #   - Request all property pages associated with a certain node
  13. #     (i.e virtual host) and a certain skill level (beginner, advanced)
  14.  
  15. class apacheModuleManager {
  16.     variable nodeArray
  17.     variable moduleArray
  18.     variable icon
  19.     variable description
  20.     variable directiveModuleRelationship
  21.     constructor {} {
  22.  
  23.     #  This array is going to be indexed by nodename, module
  24.     #   nodeArray($module,$nodeName)
  25.     #                             
  26.     #  Each one of the elements is a triplet:
  27.     #     pageName skillLevel hookPoint   
  28.  
  29.         array set nodeArray ""
  30.     array set icon ""
  31.     array set description ""
  32.     
  33.     # Module list. The value of the array should be 1 or 0 
  34.     # (enabled/disabled)
  35.  
  36.         array set moduleArray ""
  37.     array set directiveModuleRelationship ""
  38.     }
  39.     method addModuleDescription {name desc}
  40.     method addModuleIcon {name moduleIcon}
  41.     method getModuleDescription {name}
  42.     method getModuleIcon {name}
  43.     method getPropertyPagesByNodetypeList { nodeType }
  44.     method addPropertyPageNodeRelationship { module pageName nodeType args}
  45.     method getEnabledModuleList {}
  46.     method getDisabledModuleList {}    
  47.     method disableModule {module}
  48.     method enableModule {module}
  49.     method addModuleDirectivesRelationship 
  50.     method isDirectiveEnabled
  51. }
  52.     
  53. body apacheModuleManager::addModuleDescription {module desc} {
  54.      set description($module) $desc
  55. }
  56.  
  57. body apacheModuleManager::addModuleIcon {module moduleIcon} {
  58.      set icon($module) $moduleIcon
  59. }
  60.  
  61. body apacheModuleManager::getModuleDescription {module} {
  62.      return $description($module)
  63. }
  64.  
  65. body apacheModuleManager::getModuleIcon {module} {
  66.      return $icon($module)
  67. }
  68.  
  69. # getEnabledModules --
  70. #     Get all modules currently enabled
  71. #
  72.  
  73. body apacheModuleManager::getEnabledModuleList {} {
  74.      set result ""
  75.      foreach one [array names moduleArray] {
  76.      if $moduleArray($one) {
  77.            lappend result $one
  78.      }
  79.      }    
  80.      return $result 
  81. }
  82.  
  83. # getDisabledModules --
  84. #     Get all modules currently disabled
  85. #
  86.  
  87. body apacheModuleManager::getDisabledModuleList {} {
  88.      set result ""
  89.      foreach one [array names moduleArray] {
  90.      if !$moduleArray($one) {
  91.            lappend result $one
  92.      }
  93.      }    
  94.      return $result 
  95. }
  96.  
  97. # enableModule --
  98. #     Enables directives for a module
  99. # 
  100.  
  101. body apacheModuleManager::enableModule {module} {
  102.     set moduleArray($module) 1  
  103. }
  104.  
  105. # disableModule --
  106. #     Disables directives for a module
  107. # 
  108.  
  109. body apacheModuleManager::disableModule {module} {
  110.     set moduleArray($module) 0
  111. }
  112.  
  113. # getPropertyPagesByNodetypeList --
  114. #          Answers backs a list with the property pages objects that are
  115. # associated with a certain node type (mainserver, virtualhost, etc)
  116. #
  117. # Arguments
  118. #     nodeType   Type of the node
  119. #
  120. # Returns
  121. #     list of xuiObjects
  122.  
  123. body apacheModuleManager::getPropertyPagesByNodetypeList { nodeType } {
  124.     set result ""
  125.     foreach match [array names nodeArray *,[string tolower $nodeType]] {
  126.  
  127.     # Check if module enabled
  128.          
  129.     if $moduleArray([lindex [split $match ,] 0]) {
  130.         foreach page $nodeArray($match) {
  131.         lappend result $page
  132.         }
  133.     }
  134.     }
  135.     return $result
  136. }
  137.  
  138. # apacheModuleManager::addPropertyPageNodeRelationship --
  139. #   Associates, for a certain module and nodetype a property page, the skill
  140. # for that property page (newbie/advanced) and where to hook under that 
  141. # property page
  142.  
  143. body apacheModuleManager::addPropertyPageNodeRelationship { module pageName \
  144.     nodeType args } {
  145.     array set options {-hookUnder root -skillLevel all}
  146.     array set options $args
  147.     if ![info exists moduleArray($module)] {
  148.     set moduleArray($module) 1
  149.     }
  150.     lappend nodeArray($module,[string tolower $nodeType]) \
  151.         [list  $pageName $options(-skillLevel) $options(-hookUnder)]
  152. }
  153.  
  154.  
  155. # All directives that belong to that module
  156.  
  157. body apacheModuleManager::addModuleDirectivesRelationship {module directiveList} {
  158.     foreach dir $directiveList {
  159.     set directiveModuleRelationship([string tolower $dir]) $module
  160.     }
  161. }
  162.  
  163. body apacheModuleManager::isDirectiveEnabled {directive} {
  164.  
  165.     # If not exists, is unknown, thus enabled
  166.  
  167.     if ![ info exists directiveModuleRelationship($directive)] { return 1 }
  168.     return $moduleArray($directiveModuleRelationship($directive))
  169. }
  170.