BBMAP is a set of PHP pages (mainly) that tend to give a status map capacity to Big Brother.

DETAILS

TODO

  DETAILS

• The globalmap.cfg file: The main file containing default settings
  
  Can be overriden by settings in map file.
  Comments (lines beggining with ;) or empty lines are ignored
  See the file to get details.
  
• The bbmap/map/*.map files: Each map use a map file, overriden the settings of globalmap.cfg
  
  Comments (lines beggining with ; or #) or empty lines are ignored
  These files can be created with the php pages (from selectmap.php).
  This way of creation (through web admin pages) overwrites the file *.map selected.
  The structure of a map file is as follow:
  

    ; set the background map
  
    BACKGROUND = filemap.png (default : the one defined in globalmap.cfg)
  
    ; In order to limit bbgen creation part, not mandatory
    ; services defined in host are prioritary
    ; if none are defined (neither in SERVICES, neither in hosts), then full services
  
    SERVICES = service1:serv2:... 
  
    ; host, hostgroup and submap definitions : '[' and ']' means optional, 'xxx,...' means comma separated list
  
    HOST = hostname:parenthost1,...:x:y:picture[:serv1,serv2,... (limit of services, prioritary on SERVICES]
    HOSTGROUP = hostgroupname:parenthost1,...:x:y:picture:host1,host2,host3,...[:serv1,serv2,...]
    SUBMAP = submapname:parenthost1,...:x:y:picture
  
    ; where hostname is one of the hostname in bb-hosts
    ; where submapname is whatever you want except a hostname in bb4
    ; where hostgroupname is whatever you want except a hostname in bb4 or a submapname
    ; where parenthost is empty for no parent or a comma separated list of the hostname or hostgroupname
    ; or a comma separated list of '!' separated list like 
    ; hostname[!color[!width[!title]]],hostgroupname[!color[!width[!title]]],...
  
    ; where options are color, width and title (set as you want) for the link between host and parent
    ; where x and y are central coordinate in the map
    ; where picture is one of (rectangle,square,diamond,triangle,circle) or a picture file name
    ; where service is one of column headers in bb web page
  
    VAR = name:value
    ; in order to override for one particular map some value (title for instance)
  

  
  

• selectmap.php:
  
  set a map file (*.map) and use redirect.php to go to the right php page (createmap.php, selectoption.php, display.php, or in user case specdisplay.php)
  
  
• display.php:
  
  Display a map for the administrator point of vue.
  Use of :
  • sjava.php (for status over the map)
  • initiate.php (read globalmap.cfg then *.map file, overriding the settings in globalmap.cfg, and initialize some vars,
  • statusreturn.sh (to get the bb4 status from bbvar)
  • smenu.php (for the administrator menu)
  • maparea.php (create the map AREA)
  • status.php (to display bbgen detailed status using statusbbgen.sh)
  • statusbbgen.sh (call to bbgen)
  • create.php (to create the map png picture) (get info from initiate through serialize.php)
  
  
  
• create.php:
  
  create the map png picture (using GD library)
  Use of :
  • initiate.php (or serialize.php if possible)
  • statusreturn.sh
  
  
  
• createmap.php:
  
  Help to create map using Web page.
  Use of :
  • initiate.php
  • statusreturn.sh
  • smenu.php
  • savecfgfile.php (Write the map file)
  • pictlist.php (get the picture shape list in bbmap/base)
  • servlist.php (get the service lists available in bb4 (bbvar))
  • create.php (use serialize.php if possible)
  
  
  
• selectoption.php:
  
  Help to change the settings of the map using Web page.
  Use of :
  • initiate.php
  • statusreturn.sh
  • sjava.php
  • maparea.php
  • ColorPicker2B.js (select a color over the web page : java)
  • smenu.php
  • selectmapoption.php (save map file for map option)
  • selecthostoption.php (save map file for host option)
  • selectcoloroption.php (save map file for color option)
  • selectservoption.php (save map file for service option)
  • selecthostgroupoption.php (save filehost.cfg file for hostgroup option)
  
  
  
• initiate.php/initpostserial.php/initiatesubmap.php:
  
  create GlobalService (list of accepted services), GlobalStatus (background color) and create GlobalHost (list of everything usefull after)
  GlobalHost will be as follow after this file: ('[' and ']' means an array in PHP - PHP enables array of arrays)
  

    GlobalHost['Name_of_host'] =
    [ (0):Name_of_host,
      (1):[[Name_of_parent_host1,color1,width1,title1],
           [Name_of_parent_host2,color1,width1,title1], ...],
      (2):'HOST' or 'HOSTGROUP' or 'SUBMAP',
      (3):x, (4):y,
      (5):picture_namefile,
      (6):empty (HOST,SUBMAP) or [ host1, host2, ...](HOSTGROUP),
      (7):[service1, service2, ...] (optional service list, empty if SUBMAP),
      (8):[(0):host(group) global color (1-6) base on the service list,
           (1):[serv1, serv2, ...] (HOST) or [host1, host2, ...] (HOSTGROUP,SUBMAP) in color 1,
  	 (2): same for color 2, ..., (6): same for color 6]    ]
      (9):[shape(area), coord for area, picture in java scrip]
    ]
  

  So GlobalHost['hostname'][3] gives for instance the X position on the map of hostname.