bin/plc-kml.py

   1 #!/usr/bin/env plcsh
   2 #
   3 # this script generates a kml file, located under the default location below
   4 # you should crontab this job from your myplc image
   5 # you can then use the googlemap.js javascript for creating your applet
   6 # more on this at http://svn.planet-lab.org/wiki/GooglemapSetup
   7 #
   8 # kml reference can be found at
   9 # http://code.google.com/apis/kml/documentation/kmlreference.html
  10 #
  11
  12 import sys
  13
  14 default_output           = "/var/www/html/sites/sites.kml"
  15 default_local_icon       = "sites/google-local.png"
  16 default_foreign_icon     = "sites/google-foreign.png"
  17 default_local_builtin    = "palette-4.png"
  18 default_foreign_builtin  = "palette-3.png"
  19
  20 class KmlMap:
  21
  22     def __init__ (self,outputname,options):
  23         self.outputname=outputname
  24         self.options=options
  25
  26     def open (self):
  27         self.output = open(self.outputname,"w")
  28
  29     def close (self):
  30         if self.output:
  31             self.output.close()
  32         self.output = None
  33
  34     def write(self,string):
  35         self.output.write(string.encode("UTF-8"))
  36
  37     # mention local last
  38     @staticmethod
  39     def site_compare (s1,s2):
  40         p1 = p2 = 0
  41         if s1['peer_id']: p1=s1['peer_id']
  42         if s2['peer_id']: p2=s2['peer_id']
  43         return p2-p1
  44
  45     def refresh (self):
  46         self.open()
  47         self.write_header()
  48         # cache peers
  49         peers = GetPeers({},['peer_id','peername'])
  50         all_sites = GetSites({'enabled':True,'is_public':True})
  51         all_sites.sort(KmlMap.site_compare)
  52         for site in all_sites:
  53             self.write_site(site,peers)
  54         self.write_footer()
  55         self.close()
  56
  57 # initial placement is for europe - dunno how to tune that yet
  58     def write_header (self):
  59         self.write("""<?xml version="1.0" encoding="UTF-8"?>
  60 <kml xmlns="http://earth.google.com/kml/2.2">
  61 <Document>
  62 <name> PlanetLab Sites </name>
  63 <LookAt>
  64 <longitude>9.180821112577378</longitude>
  65 <latitude>44.43275321178062</latitude>
  66 <altitude>0</altitude>
  67 <range>5782133.196489797</range>
  68 <tilt>0</tilt>
  69 <heading>-7.767386340832667</heading>
  70 </LookAt>
  71 <description> All the sites known to the PlanetLab testbed. </description>
  72 """)
  73
  74     def write_footer (self):
  75         self.write("""</Document></kml>
  76 """)
  77
  78     def peer_name (self,site, peers):
  79         if not site['peer_id']:
  80             return "local"
  81         for peer in peers:
  82             if peer['peer_id'] == site['peer_id']:
  83                 return peer['peername']
  84
  85     def write_site (self, site, peers):
  86         # discard sites with missing lat or lon
  87         if not site['latitude'] or not site['longitude']:
  88             return
  89         # discard sites with no nodes
  90         if len(site['node_ids']) == 0:
  91             return
  92
  93         site_id=site['site_id']
  94         name=site['name']
  95         nb_nodes=len(site['node_ids'])
  96         nb_slices=len(site['slice_ids'])
  97         latitude=site['latitude']
  98         longitude=site['longitude']
  99         apiurl='https://%s:443'%api.config.PLC_WWW_HOST
 100         baseurl='http://%s'%api.config.PLC_WWW_HOST
 101         peer_id=site['peer_id']
 102
 103         # open description
 104         description='<ul>'
 105         # Name and URL
 106         description += '<li>'
 107         description += '<a href="%(apiurl)s/db/sites/index.php?id=%(site_id)d"> Site page </a>'%locals()
 108         if site['url']:
 109             site_url=site['url']
 110             description += ' -- <a href="%(site_url)s"> %(site_url)s </a>'%locals()
 111         description += '</li>'
 112         # NODES
 113         if nb_nodes:
 114             description += '<li>'
 115             description += '<a href="%(apiurl)s/db/nodes/index.php?site_id=%(site_id)d">%(nb_nodes)d node(s)</a>'%locals()
 116             description += '<a href="%(apiurl)s/db/nodes/comon.php?site_id=%(site_id)d"> (in Comon)</a>'%locals()
 117             description += '</li>'
 118         else:
 119             description += '<li>No node</li>'
 120         #SLICES
 121         if nb_slices:
 122             description += '<li><a href="%(apiurl)s/db/slices/index.php?site_id=%(site_id)d">%(nb_slices)d slice(s)</a></li>'%locals()
 123         else:
 124             description += '<li>No slice</li>'
 125         # PEER
 126         if peer_id:
 127             peername = self.peer_name(site,peers)
 128             description += '<li>'
 129             description += '<a href="%(apiurl)s/db/peers/index.php?id=%(peer_id)d">At peer %(peername)s</a>'%locals()
 130             description += '</li>'
 131         # close description
 132         description +='</ul>'
 133
 134         if not self.options.labels:
 135             name=""
 136             description=""
 137
 138         # STYLE
 139         if self.options.use_google_icons:
 140             if not peer_id:
 141                 # local sites
 142                 iconfile=default_local_builtin
 143                 xyspec="<x>128</x><y>0</y><w>32</w><h>32</h>"
 144             else:
 145                 # remote
 146                 iconfile=default_foreign_builtin
 147                 xyspec="<x>160</x><y>0</y><w>32</w><h>32</h>"
 148             iconurl="root://icons/%(iconfile)s"%locals()
 149         else:
 150             if not peer_id:
 151                 iconfile=self.options.local_icon
 152             else:
 153                 iconfile=self.options.foreign_icon
 154             iconurl="%(baseurl)s/%(iconfile)s"%locals()
 155             xyspec=""
 156
 157         iconspec="<href>%(iconurl)s</href>%(xyspec)s"%locals()
 158
 159         # set the camera 50km high
 160         template="""<Placemark>
 161 <Style><IconStyle><Icon>%(iconspec)s</Icon></IconStyle></Style>
 162 <name><![CDATA[%(name)s]]></name>
 163 <LookAt>
 164   <latitude>%(latitude)f</latitude>
 165   <longitude>%(longitude)f</longitude>
 166   <altitude>0</altitude>
 167   <altitudeMode>relativeToGround</altitudeMode>
 168   <range>50000.</range>
 169 </LookAt>
 170 <description><![CDATA[%(description)s]]></description>
 171 <Point> <coordinates>%(longitude)f,%(latitude)f,0</coordinates> </Point>
 172 </Placemark>
 173 """
 174         self.write(template%locals())
 175
 176 def main () :
 177     from optparse import OptionParser
 178     usage = "Usage %prog [plcsh-options] [ -- options ]"
 179     parser = OptionParser (usage=usage)
 180
 181     parser.add_option("-o","--output",action="store",dest="output",
 182                       default=default_output,
 183                       help="output file - default is %s"%default_output)
 184     parser.add_option("-n","--no-label",action="store_false",dest="labels",
 185                       default=True,
 186                       help="outputs only geographic positions, no labels")
 187     parser.add_option("-c","--custom",action="store_false",dest="use_google_icons",
 188                       default=True,
 189                       help="use locally customized icons rather than the google-provided defaults")
 190     parser.add_option("-l","--local",action="store",dest="local_icon",
 191                       default=default_local_icon,
 192                       help="set icon url to use for local sites marker -- default is %s"%default_local_icon)
 193     parser.add_option("-f","--foreign",action="store",dest="foreign_icon",
 194                       default=default_foreign_icon,
 195                       help="set icon url to use for foreign sites marker -- default is %s"%default_foreign_icon)
 196
 197     (options, args) = parser.parse_args()
 198     if len(args) != 0:
 199         parser.print_help()
 200         sys.exit(1)
 201     KmlMap(options.output,options).refresh()
 202
 203 ####################
 204 if __name__ == "__main__":
 205     main()