2016-06-14 10:04:23 +00:00
#!/usr/bin/env python
#
# Copyright (C) 2016 GNS3 Technologies Inc.
#
# 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 3 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, see <http://www.gnu.org/licenses/>.
2016-06-14 14:07:37 +00:00
import json
2016-07-11 13:36:52 +00:00
import jsonschema
2016-07-07 10:10:42 +00:00
import uuid
import shutil
2016-06-14 14:07:37 +00:00
import aiohttp
2016-06-14 10:04:23 +00:00
from . . version import __version__
2016-07-11 13:36:52 +00:00
from . . schemas . topology import TOPOLOGY_SCHEMA
import logging
log = logging . getLogger ( __name__ )
2016-06-14 10:04:23 +00:00
2016-06-14 14:07:37 +00:00
GNS3_FILE_FORMAT_REVISION = 5
2016-06-14 10:04:23 +00:00
2016-06-14 14:57:13 +00:00
2016-07-11 13:36:52 +00:00
def _check_topology_schema ( topo ) :
try :
jsonschema . validate ( topo , TOPOLOGY_SCHEMA )
except jsonschema . ValidationError as e :
error = " Invalid data in topology file: {} in schema: {} " . format (
e . message ,
json . dumps ( e . schema ) )
log . critical ( error )
raise aiohttp . web . HTTPConflict ( text = error )
2016-06-14 10:04:23 +00:00
def project_to_topology ( project ) :
"""
: return : A dictionnary with the topology ready to dump to a . gns3
"""
data = {
" project_id " : project . id ,
" name " : project . name ,
2016-07-07 10:10:42 +00:00
" auto_start " : project . auto_start ,
2016-06-14 10:04:23 +00:00
" topology " : {
" nodes " : [ ] ,
" links " : [ ] ,
2016-06-20 16:45:31 +00:00
" computes " : [ ] ,
2016-06-23 09:17:23 +00:00
" drawings " : [ ]
2016-06-14 10:04:23 +00:00
} ,
" type " : " topology " ,
2016-06-14 14:07:37 +00:00
" revision " : GNS3_FILE_FORMAT_REVISION ,
2016-06-14 10:04:23 +00:00
" version " : __version__
}
computes = set ( )
for node in project . nodes . values ( ) :
computes . add ( node . compute )
2016-06-15 13:12:38 +00:00
data [ " topology " ] [ " nodes " ] . append ( node . __json__ ( topology_dump = True ) )
2016-06-14 10:04:23 +00:00
for link in project . links . values ( ) :
2016-06-15 13:12:38 +00:00
data [ " topology " ] [ " links " ] . append ( link . __json__ ( topology_dump = True ) )
2016-06-23 09:17:23 +00:00
for drawing in project . drawings . values ( ) :
data [ " topology " ] [ " drawings " ] . append ( drawing . __json__ ( topology_dump = True ) )
2016-06-14 10:04:23 +00:00
for compute in computes :
if hasattr ( compute , " __json__ " ) :
2016-06-15 13:12:38 +00:00
data [ " topology " ] [ " computes " ] . append ( compute . __json__ ( topology_dump = True ) )
2016-07-11 13:36:52 +00:00
_check_topology_schema ( data )
2016-06-14 10:04:23 +00:00
return data
2016-06-14 14:07:37 +00:00
def load_topology ( path ) :
"""
Open a topology file , patch it for last GNS3 release and return it
"""
2016-07-07 10:10:42 +00:00
log . debug ( " Read topology %s " , path )
2016-06-14 14:07:37 +00:00
try :
with open ( path ) as f :
topo = json . load ( f )
except OSError as e :
raise aiohttp . web . HTTPConflict ( text = " Could not load topology {} : {} " . format ( path , str ( e ) ) )
2016-07-07 10:10:42 +00:00
if " revision " not in topo or topo [ " revision " ] < GNS3_FILE_FORMAT_REVISION :
# If it's an old GNS3 file we need to convert it
# first we backup the file
shutil . copy ( path , path + " .backup " )
topo = _convert_1_3_later ( topo )
with open ( path , " w+ " ) as f :
json . dump ( topo , f )
elif topo [ " revision " ] > GNS3_FILE_FORMAT_REVISION :
raise aiohttp . web . HTTPConflict ( text = " This project is designed for a more recent version of GNS3 please update GNS3 to version {} or later " . format ( topo [ " version " ] ) )
2016-07-11 13:36:52 +00:00
_check_topology_schema ( topo )
2016-06-14 14:07:37 +00:00
return topo
2016-07-07 10:10:42 +00:00
def _convert_1_3_later ( topo ) :
"""
Convert topologies to the new file format
Look in tests / topologies / README . rst for instructions to test changes here
"""
new_topo = {
" type " : " topology " ,
" revision " : GNS3_FILE_FORMAT_REVISION ,
" version " : __version__ ,
" auto_start " : topo . get ( " auto_start " , False ) ,
" name " : topo [ " name " ] ,
" project_id " : topo [ " project_id " ] ,
" topology " : {
" links " : [ ] ,
" drawings " : [ ] ,
" computes " : [ ] ,
" nodes " : [ ]
}
}
if new_topo [ " project_id " ] is None :
new_topo [ " project_id " ] = str ( uuid . uuid4 ( ) ) # Could arrive for topologues with drawing only
if " topology " not in topo :
return new_topo
topo = topo [ " topology " ]
# Create computes
server_id_to_compute_id = { }
for server in topo . get ( " servers " , [ ] ) :
compute = {
" host " : server . get ( " host " , " localhost " ) ,
" port " : server . get ( " port " , 3080 ) ,
" protocol " : server . get ( " protocol " , " http " )
}
if server [ " local " ] :
compute [ " compute_id " ] = " local "
compute [ " name " ] = " Local "
elif server . get ( " vm " , False ) :
compute [ " compute_id " ] = " vm "
compute [ " name " ] = " GNS3 VM "
else :
compute [ " name " ] = " Remote {} " . format ( server [ " id " ] )
compute [ " compute_id " ] = str ( uuid . uuid4 ( ) )
server_id_to_compute_id [ server [ " id " ] ] = compute [ " compute_id " ]
new_topo [ " topology " ] [ " computes " ] . append ( compute )
# Create nodes
ports = { }
node_id_to_node_uuid = { }
for old_node in topo . get ( " nodes " , [ ] ) :
node = { }
node [ " console " ] = old_node [ " properties " ] . get ( " console " , None )
node [ " compute_id " ] = server_id_to_compute_id [ old_node [ " server_id " ] ]
node [ " console_type " ] = old_node [ " properties " ] . get ( " console_type " , " telnet " )
node [ " name " ] = old_node [ " label " ] [ " text " ]
node [ " label " ] = _convert_label ( old_node [ " label " ] )
node [ " node_id " ] = old_node . get ( " vm_id " , str ( uuid . uuid4 ( ) ) )
node [ " symbol " ] = old_node . get ( " symbol " , None )
node [ " x " ] = int ( old_node [ " x " ] )
node [ " y " ] = int ( old_node [ " y " ] )
node [ " z " ] = int ( old_node . get ( " z " , 1 ) )
node [ " properties " ] = { }
if old_node [ " type " ] == " VPCSDevice " :
node [ " node_type " ] = " vpcs "
elif old_node [ " type " ] == " QemuVM " :
node [ " node_type " ] = " qemu "
if node [ " symbol " ] is None :
node [ " symbol " ] = " :/symbols/qemu_guest.svg "
elif old_node [ " type " ] == " DockerVM " :
node [ " node_type " ] = " docker "
if node [ " symbol " ] is None :
node [ " symbol " ] = " :/symbols/docker_guest.svg "
elif old_node [ " type " ] == " ATMSwitch " :
node [ " node_type " ] = " atm_switch "
node [ " symbol " ] = " :/symbols/atm_switch.svg "
node [ " console_type " ] = None
elif old_node [ " type " ] == " EthernetHub " :
node [ " node_type " ] = " ethernet_hub "
node [ " symbol " ] = " :/symbols/hub.svg "
node [ " console_type " ] = None
node [ " properties " ] [ " ports " ] = [ ]
for port in old_node [ " ports " ] :
node [ " properties " ] [ " ports " ] . append ( {
" name " : " Ethernet {} " . format ( port [ " port_number " ] ) ,
" port_number " : port [ " port_number " ]
} )
elif old_node [ " type " ] == " EthernetSwitch " :
node [ " node_type " ] = " ethernet_switch "
node [ " symbol " ] = " :/symbols/ethernet_switch.svg "
node [ " properties " ] [ " ports " ] = [ ]
node [ " console_type " ] = None
for port in old_node [ " ports " ] :
node [ " properties " ] [ " ports " ] . append ( {
" name " : " Ethernet {} " . format ( port [ " port_number " ] ) ,
" port_number " : port [ " port_number " ] ,
" type " : port [ " type " ] ,
" vlan " : port [ " vlan " ]
} )
elif old_node [ " type " ] == " FrameRelaySwitch " :
node [ " node_type " ] = " frame_relay_switch "
node [ " symbol " ] = " :/symbols/frame_relay_switch.svg "
node [ " console_type " ] = None
elif old_node [ " type " ] in [ " C1700 " , " C2600 " , " C2691 " , " C3600 " , " C3725 " , " C3745 " , " C7200 " , " EtherSwitchRouter " ] :
if node [ " symbol " ] is None :
node [ " symbol " ] = " :/symbols/router.svg "
node [ " node_type " ] = " dynamips "
node [ " properties " ] [ " dynamips_id " ] = old_node [ " dynamips_id " ]
elif old_node [ " type " ] == " VMwareVM " :
node [ " node_type " ] = " vmware "
if node [ " symbol " ] is None :
node [ " symbol " ] = " :/symbols/vmware_guest.svg "
elif old_node [ " type " ] == " VirtualBoxVM " :
node [ " node_type " ] = " virtualbox "
if node [ " symbol " ] is None :
node [ " symbol " ] = " :/symbols/vbox_guest.svg "
2016-07-12 15:38:13 +00:00
elif old_node [ " type " ] == " Cloud " :
2016-07-12 16:48:01 +00:00
_create_cloud ( node , old_node )
2016-07-07 10:10:42 +00:00
else :
raise NotImplementedError ( " Conversion of {} is not supported " . format ( old_node [ " type " ] ) )
for prop in old_node [ " properties " ] :
if prop not in [ " console " , " name " , " console_type " , " use_ubridge " ] :
node [ " properties " ] [ prop ] = old_node [ " properties " ] [ prop ]
node_id_to_node_uuid [ old_node [ " id " ] ] = node [ " node_id " ]
for port in old_node . get ( " ports " , [ ] ) :
ports [ port [ " id " ] ] = port
new_topo [ " topology " ] [ " nodes " ] . append ( node )
# Create links
for old_link in topo . get ( " links " , [ ] ) :
nodes = [ ]
source_node = {
" adapter_number " : ports [ old_link [ " source_port_id " ] ] . get ( " adapter_number " , 0 ) ,
" port_number " : ports [ old_link [ " source_port_id " ] ] [ " port_number " ] ,
" node_id " : node_id_to_node_uuid [ old_link [ " source_node_id " ] ]
}
nodes . append ( source_node )
destination_node = {
" adapter_number " : ports [ old_link [ " destination_port_id " ] ] . get ( " adapter_number " , 0 ) ,
" port_number " : ports [ old_link [ " destination_port_id " ] ] [ " port_number " ] ,
" node_id " : node_id_to_node_uuid [ old_link [ " destination_node_id " ] ]
}
nodes . append ( destination_node )
link = {
" link_id " : str ( uuid . uuid4 ( ) ) ,
" nodes " : nodes
}
new_topo [ " topology " ] [ " links " ] . append ( link )
# Ellipse
for ellipse in topo . get ( " ellipses " , [ ] ) :
svg = ' <svg height= " {height} " width= " {width} " ><ellipse cx= " {cx} " cy= " {cy} " fill= " {fill} " fill-opacity= " 1.0 " rx= " {rx} " ry= " {ry} " {border_style} /></svg> ' . format (
height = int ( ellipse [ " height " ] ) ,
width = int ( ellipse [ " width " ] ) ,
cx = int ( ellipse [ " width " ] / 2 ) ,
cy = int ( ellipse [ " height " ] / 2 ) ,
rx = int ( ellipse [ " width " ] / 2 ) ,
ry = int ( ellipse [ " height " ] / 2 ) ,
fill = ellipse . get ( " color " , " #ffffff " ) ,
border_style = _convert_border_style ( ellipse )
)
new_ellipse = {
" drawing_id " : str ( uuid . uuid4 ( ) ) ,
" x " : int ( ellipse [ " x " ] ) ,
" y " : int ( ellipse [ " y " ] ) ,
" z " : int ( ellipse . get ( " z " , 0 ) ) ,
" rotation " : int ( ellipse . get ( " rotation " , 0 ) ) ,
" svg " : svg
}
new_topo [ " topology " ] [ " drawings " ] . append ( new_ellipse )
# Notes
for note in topo . get ( " notes " , [ ] ) :
font_info = note [ " font " ] . split ( " , " )
if font_info [ 4 ] == " 75 " :
weight = " bold "
else :
weight = " normal "
if font_info [ 5 ] == " 1 " :
style = " italic "
else :
style = " normal "
svg = ' <svg height= " {height} " width= " {width} " ><text fill= " {fill} " fill-opacity= " {opacity} " font-family= " {family} " font-size= " {size} " font-weight= " {weight} " font-style= " {style} " > {text} </text></svg> ' . format (
height = int ( font_info [ 1 ] ) * 2 ,
width = int ( font_info [ 1 ] ) * len ( note [ " text " ] ) ,
fill = " # " + note [ " color " ] [ - 6 : ] ,
opacity = round ( 1.0 / 255 * int ( note [ " color " ] [ : 3 ] [ - 2 : ] , base = 16 ) , 2 ) , # Extract the alpha channel from the hexa version
family = font_info [ 0 ] ,
size = int ( font_info [ 1 ] ) ,
weight = weight ,
style = style ,
text = note [ " text " ]
)
new_note = {
" drawing_id " : str ( uuid . uuid4 ( ) ) ,
" x " : int ( note [ " x " ] ) ,
" y " : int ( note [ " y " ] ) ,
" z " : int ( note . get ( " z " , 0 ) ) ,
" rotation " : int ( ellipse . get ( " rotation " , 0 ) ) ,
" svg " : svg
}
new_topo [ " topology " ] [ " drawings " ] . append ( new_note )
# Rectangles
for rectangle in topo . get ( " rectangles " , [ ] ) :
svg = ' <svg height= " {height} " width= " {width} " ><rect fill= " {fill} " fill-opacity= " 1.0 " height= " {height} " width= " {width} " {border_style} /></svg> ' . format (
height = int ( rectangle [ " height " ] ) ,
width = int ( rectangle [ " width " ] ) ,
fill = rectangle . get ( " color " , " #ffffff " ) ,
border_style = _convert_border_style ( rectangle )
)
new_rectangle = {
" drawing_id " : str ( uuid . uuid4 ( ) ) ,
" x " : int ( rectangle [ " x " ] ) ,
" y " : int ( rectangle [ " y " ] ) ,
" z " : int ( rectangle . get ( " z " , 0 ) ) ,
" rotation " : int ( ellipse . get ( " rotation " , 0 ) ) ,
" svg " : svg
}
new_topo [ " topology " ] [ " drawings " ] . append ( new_rectangle )
return new_topo
def _convert_border_style ( element ) :
QT_DASH_TO_SVG = {
2 : " 25, 25 " ,
3 : " 5, 25 " ,
4 : " 5, 25, 25 " ,
5 : " 25, 25, 5, 25, 5 "
}
border_style = int ( element . get ( " border_style " , 0 ) )
style = " "
if border_style == 1 : # No border
return " "
elif border_style == 0 :
pass # Solid line
else :
style + = ' stroke-dasharray= " {} " ' . format ( QT_DASH_TO_SVG [ border_style ] )
style + = ' stroke= " {stroke} " stroke-width= " {stroke_width} " ' . format (
stroke = element . get ( " border_color " , " #000000 " ) ,
stroke_width = element . get ( " border_width " , 2 )
)
return style
def _convert_label ( label ) :
"""
Convert a label from 1. X to the new format
"""
font_info = label [ " font " ] . split ( " , " )
style = " font-family: {} ;font-size: {} ; " . format ( font_info [ 0 ] , font_info [ 1 ] )
if font_info [ 4 ] == " 75 " :
style + = " font-weight: bold; "
if font_info [ 5 ] == " 1 " :
style + = " font-style: italic; "
color = label [ " color " ]
style + = " fill: # " + color [ - 6 : ] + " ; "
style + = " fill-opacity: {} ; " . format ( round ( 1.0 / 255 * int ( color [ : 3 ] [ - 2 : ] , base = 16 ) , 2 ) )
return {
" text " : label [ " text " ] ,
" rotation " : 0 ,
" style " : style ,
" x " : int ( label [ " x " ] ) ,
" y " : int ( label [ " y " ] )
}
2016-07-12 16:48:01 +00:00
def _create_cloud ( node , old_node ) :
node [ " node_type " ] = " cloud "
node [ " symbol " ] = " :/symbols/cloud.svg "
node [ " console_type " ] = None
node [ " console " ] = None
del old_node [ " properties " ] [ " nios " ]
ports = [ ]
for old_port in old_node . get ( " ports " , [ ] ) :
if old_port [ " name " ] . startswith ( " nio_gen_eth " ) :
port_type = " ethernet "
elif old_port [ " name " ] . startswith ( " nio_gen_linux " ) :
port_type = " ethernet "
elif old_port [ " name " ] . startswith ( " nio_tap " ) :
port_type = " tap "
else :
raise NotImplementedError ( " The conversion of cloud with {} is not supporterd " . format ( old_port [ " name " ] ) )
port = {
" interface " : old_port [ " name " ] . split ( " : " ) [ 1 ] ,
" name " : old_port [ " name " ] . split ( " : " ) [ 1 ] ,
" port_number " : len ( ports ) + 1 ,
" type " : port_type
}
ports . append ( port )
node [ " properties " ] [ " ports " ] = ports
node [ " properties " ] [ " interfaces " ] = [ ]