virt-manager/src/virtManager/createnet.py

#
# Copyright (C) 2006-2007 Red Hat, Inc.
# Copyright (C) 2006 Hugh O. Brock <hbrock@redhat.com>
#
# 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 2 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, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
# MA 02110-1301 USA.
#

import logging
import re

import gtk

from virtManager.IPy import IP
from virtManager.network import vmmNetwork
from virtManager.baseclass import vmmGObjectUI

PAGE_INTRO = 0
PAGE_NAME = 1
PAGE_IPV4 = 2
PAGE_DHCP = 3
PAGE_FORWARDING = 4
PAGE_SUMMARY = 5


class vmmCreateNetwork(vmmGObjectUI):
    def __init__(self, conn):
        vmmGObjectUI.__init__(self, "vmm-create-net.glade", "vmm-create-net")
        self.conn = conn

        self.window.signal_autoconnect({
            "on_create_pages_switch_page" : self.page_changed,
            "on_create_cancel_clicked" : self.close,
            "on_vmm_create_delete_event" : self.close,
            "on_create_back_clicked" : self.back,
            "on_create_forward_clicked" : self.forward,
            "on_create_finish_clicked" : self.finish,

            "on_net_name_activate": self.forward,
            "on_net_forward_toggled" : self.change_forward_type,
            "on_net_network_changed": self.change_network,
            "on_net_dhcp_enable_toggled": self.change_dhcp_enable,
            "on_net_dhcp_start_changed": self.change_dhcp_start,
            "on_net_dhcp_end_changed": self.change_dhcp_end,
            "on_create_help_clicked": self.show_help,
            })
        self.bind_escape_key_close()

        # XXX: Help docs useless/out of date
        self.window.get_widget("create-help").hide()
        finish_img = gtk.image_new_from_stock(gtk.STOCK_QUIT,
                                              gtk.ICON_SIZE_BUTTON)
        self.window.get_widget("create-finish").set_image(finish_img)

        self.set_initial_state()

    def show(self, parent):
        self.reset_state()
        self.topwin.set_transient_for(parent)
        self.topwin.present()

    def is_visible(self):
        if self.topwin.flags() & gtk.VISIBLE:
            return 1
        return 0

    def close(self, ignore1=None, ignore2=None):
        self.topwin.hide()
        return 1

    def cleanup(self):
        self.close()
        self.conn = None

        vmmGObjectUI.cleanup(self)

    def set_initial_state(self):
        notebook = self.window.get_widget("create-pages")
        notebook.set_show_tabs(False)

        black = gtk.gdk.color_parse("#000")
        for num in range(PAGE_SUMMARY + 1):
            name = "page" + str(num) + "-title"
            self.window.get_widget(name).modify_bg(gtk.STATE_NORMAL, black)

        fw_list = self.window.get_widget("net-forward")
        # [ label, dev name ]
        fw_model = gtk.ListStore(str, str)
        fw_list.set_model(fw_model)
        text = gtk.CellRendererText()
        fw_list.pack_start(text, True)
        fw_list.add_attribute(text, 'text', 0)

        fw_model.append([_("Any physical device"), None])
        for path in self.conn.list_net_device_paths():
            net = self.conn.get_net_device(path)
            fw_model.append([_("Physical device %s") % (net.get_name()),
                             net.get_name()])

        mode_list = self.window.get_widget("net-forward-mode")
        # [ label, mode ]
        mode_model = gtk.ListStore(str, str)
        mode_list.set_model(mode_model)
        text = gtk.CellRendererText()
        mode_list.pack_start(text, True)
        mode_list.add_attribute(text, 'text', 0)

        mode_model.append([_("NAT"), "nat"])
        mode_model.append([_("Routed"), "route"])

    def reset_state(self):
        notebook = self.window.get_widget("create-pages")
        notebook.set_current_page(0)
        # Hide the "finish" button until the appropriate time
        self.window.get_widget("create-finish").hide()
        self.window.get_widget("create-forward").show()
        self.window.get_widget("create-forward").grab_focus()
        self.window.get_widget("create-back").set_sensitive(False)

        self.window.get_widget("net-name").set_text("")
        self.window.get_widget("net-network").set_text("192.168.100.0/24")
        self.window.get_widget("net-dhcp-enable").set_active(True)
        self.window.get_widget("net-dhcp-start").set_text("")
        self.window.get_widget("net-dhcp-end").set_text("")
        self.window.get_widget("net-forward-none").set_active(True)

        self.window.get_widget("net-forward").set_active(0)
        self.window.get_widget("net-forward-mode").set_active(0)


    def forward(self, ignore=None):
        notebook = self.window.get_widget("create-pages")
        if(self.validate(notebook.get_current_page()) != True):
            return

        self.window.get_widget("create-forward").grab_focus()
        notebook.next_page()

    def back(self, ignore=None):
        notebook = self.window.get_widget("create-pages")
        # do this always, since there's no "leaving a notebook page" event.
        self.window.get_widget("create-finish").hide()
        self.window.get_widget("create-forward").show()
        notebook.prev_page()

    def change_network(self, src):
        ip = self.get_config_ip4()
        green = gtk.gdk.color_parse("#c0ffc0")
        red = gtk.gdk.color_parse("#ffc0c0")
        black = gtk.gdk.color_parse("#000000")
        src.modify_text(gtk.STATE_NORMAL, black)

        # No IP specified or invalid IP
        if ip is None or ip.version() != 4:
            src.modify_base(gtk.STATE_NORMAL, red)
            self.window.get_widget("net-info-netmask").set_text("")
            self.window.get_widget("net-info-broadcast").set_text("")
            self.window.get_widget("net-info-gateway").set_text("")
            self.window.get_widget("net-info-size").set_text("")
            self.window.get_widget("net-info-type").set_text("")
            return

        # We've got a valid IP
        if ip.len() < 16 or ip.iptype() != "PRIVATE":
            src.modify_base(gtk.STATE_NORMAL, red)
        else:
            src.modify_base(gtk.STATE_NORMAL, green)
        self.window.get_widget("net-info-netmask").set_text(str(ip.netmask()))
        self.window.get_widget("net-info-broadcast").set_text(
                                                        str(ip.broadcast()))

        if ip.len() <= 1:
            self.window.get_widget("net-info-gateway").set_text("")
        else:
            self.window.get_widget("net-info-gateway").set_text(str(ip[1]))
        self.window.get_widget("net-info-size").set_text(_("%d addresses") %
                                                         (ip.len()))

        if ip.iptype() == "PUBLIC":
            self.window.get_widget("net-info-type").set_text(_("Public"))
        elif ip.iptype() == "PRIVATE":
            self.window.get_widget("net-info-type").set_text(_("Private"))
        elif ip.iptype() == "RESERVED":
            self.window.get_widget("net-info-type").set_text(_("Reserved"))
        else:
            self.window.get_widget("net-info-type").set_text(_("Other"))

    def change_dhcp_enable(self, src):
        val = src.get_active()
        self.window.get_widget("net-dhcp-start").set_sensitive(val)
        self.window.get_widget("net-dhcp-end").set_sensitive(val)

    def change_dhcp_start(self, src):
        end = self.get_config_dhcp_start()
        self.change_dhcp(src, end)

    def change_dhcp_end(self, src):
        end = self.get_config_dhcp_end()
        self.change_dhcp(src, end)

    def change_dhcp(self, src, addr):
        ip = self.get_config_ip4()
        black = gtk.gdk.color_parse("#000000")
        src.modify_text(gtk.STATE_NORMAL, black)

        if addr is None or not ip.overlaps(addr):
            red = gtk.gdk.color_parse("#ffc0c0")
            src.modify_base(gtk.STATE_NORMAL, red)
        else:
            green = gtk.gdk.color_parse("#c0ffc0")
            src.modify_base(gtk.STATE_NORMAL, green)

    def change_forward_type(self, src_ignore):
        skip_fwd = self.window.get_widget("net-forward-none").get_active()

        self.window.get_widget("net-forward-mode").set_sensitive(not skip_fwd)
        self.window.get_widget("net-forward").set_sensitive(not skip_fwd)

    def get_config_name(self):
        return self.window.get_widget("net-name").get_text()

    def get_config_ip4(self):
        try:
            return IP(self.window.get_widget("net-network").get_text())
        except:
            return None

    def get_config_dhcp_start(self):
        try:
            return IP(self.window.get_widget("net-dhcp-start").get_text())
        except:
            return None
    def get_config_dhcp_end(self):
        try:
            return IP(self.window.get_widget("net-dhcp-end").get_text())
        except:
            return None


    def get_config_forwarding(self):
        if self.window.get_widget("net-forward-none").get_active():
            return [None, None]
        else:
            dev = self.window.get_widget("net-forward")
            model = dev.get_model()
            active = dev.get_active()
            name = model[active][1]

            mode_w = self.window.get_widget("net-forward-mode")
            mode = mode_w.get_model()[mode_w.get_active()][1]
            return [name, mode]

    def get_config_dhcp_enable(self):
        return self.window.get_widget("net-dhcp-enable").get_active()

    def page_changed(self, notebook_ignore, page_ignore, page_number):
        # would you like some spaghetti with your salad, sir?

        if page_number == PAGE_INTRO:
            self.window.get_widget("create-back").set_sensitive(False)
        elif page_number == PAGE_NAME:
            name_widget = self.window.get_widget("net-name")
            name_widget.grab_focus()
        elif page_number == PAGE_IPV4:
            pass
        elif page_number == PAGE_DHCP:
            ip = self.get_config_ip4()
            start = int(ip.len() / 2)
            end = ip.len() - 2
            if self.window.get_widget("net-dhcp-start").get_text() == "":
                self.window.get_widget("net-dhcp-start").set_text(str(ip[start]))
            if self.window.get_widget("net-dhcp-end").get_text() == "":
                self.window.get_widget("net-dhcp-end").set_text(str(ip[end]))
        elif page_number == PAGE_FORWARDING:
            pass
        elif page_number == PAGE_SUMMARY:
            self.window.get_widget("summary-name").set_text(self.get_config_name())

            ip = self.get_config_ip4()
            self.window.get_widget("summary-ip4-network").set_text(str(ip))
            self.window.get_widget("summary-ip4-gateway").set_text(str(ip[1]))
            self.window.get_widget("summary-ip4-netmask").set_text(str(ip.netmask()))

            if self.get_config_dhcp_enable():
                start = self.get_config_dhcp_start()
                end = self.get_config_dhcp_end()
                self.window.get_widget("summary-dhcp-start").set_text(str(start))
                self.window.get_widget("summary-dhcp-end").set_text(str(end))
                self.window.get_widget("label-dhcp-start").set_text(
                                                        _("Start address:"))
                self.window.get_widget("label-dhcp-start").show()
                self.window.get_widget("label-dhcp-end").show()
                self.window.get_widget("summary-dhcp-start").show()
                self.window.get_widget("summary-dhcp-end").show()
            else:
                self.window.get_widget("label-dhcp-start").set_text(
                                                                _("Status:"))
                self.window.get_widget("summary-dhcp-start").set_text(
                                                                _("Disabled"))
                self.window.get_widget("label-dhcp-end").hide()
                self.window.get_widget("summary-dhcp-end").hide()

            forward_txt = ""
            dev, mode = self.get_config_forwarding()
            forward_txt = vmmNetwork.pretty_desc(mode, dev)

            self.window.get_widget("summary-forwarding").set_text(forward_txt)
            self.window.get_widget("create-forward").hide()
            self.window.get_widget("create-finish").show()
            self.window.get_widget("create-finish").grab_focus()


    def finish(self, ignore=None):
        name = self.get_config_name()
        ip = self.get_config_ip4()
        start = self.get_config_dhcp_start()
        end = self.get_config_dhcp_end()
        dev, mode = self.get_config_forwarding()

        xml = "<network>" + \
              "  <name>%s</name>\n" % name
        if mode:
            if dev is not None:
                xml += "  <forward mode='%s' dev='%s'/>\n" % (mode, dev)
            else:
                xml += "  <forward mode='%s'/>\n" % mode

        xml += "  <ip address='%s' netmask='%s'>\n" % (str(ip[1]), str(ip.netmask()))

        if self.get_config_dhcp_enable():
            xml += "    <dhcp>\n"
            xml += "      <range start='%s' end='%s'/>\n" % (str(start), str(end))
            xml += "    </dhcp>\n"

        xml += "  </ip>\n"
        xml += "</network>\n"

        logging.debug("About to create network " + xml)

        try:
            self.conn.create_network(xml)
        except Exception, e:
            self.err.show_err(_("Error creating virtual network: %s" % str(e)))
            return

        self.conn.tick(noStatsUpdate=True)
        self.close()

    def validate(self, page_num):
        if page_num == PAGE_NAME:
            name = self.window.get_widget("net-name").get_text()
            if len(name) > 50 or len(name) == 0:
                return self.err.val_err(_("Invalid Network Name"), \
                                        _("Network name must be non-blank and less than 50 characters"))
            if re.match("^[a-zA-Z0-9_]*$", name) == None:
                return self.err.val_err(_("Invalid Network Name"), \
                                        _("Network name may contain alphanumeric and '_' characters only"))


        elif page_num == PAGE_IPV4:
            ip = self.get_config_ip4()
            if ip is None:
                return self.err.val_err(_("Invalid Network Address"), \
                                        _("The network address could not be understood"))

            if ip.version() != 4:
                return self.err.val_err(_("Invalid Network Address"), \
                                        _("The network must be an IPv4 address"))

            if ip.len() < 16:
                return self.err.val_err(_("Invalid Network Address"), \
                                        _("The network prefix must be at least /4 (16 addresses)"))

            if ip.iptype() != "PRIVATE":
                res = self.err.yes_no(_("Check Network Address"), \
                                       _("The network should normally use a private IPv4 address. Use this non-private address anyway?"))
                if not res:
                    return False
        elif page_num == PAGE_DHCP:
            ip = self.get_config_ip4()
            start = self.get_config_dhcp_start()
            end = self.get_config_dhcp_end()
            enabled = self.window.get_widget("net-dhcp-enable").get_active()

            if enabled and start is None:
                return self.err.val_err(_("Invalid DHCP Address"), \
                                        _("The DHCP start address could not be understood"))
            if enabled and end is None:
                return self.err.val_err(_("Invalid DHCP Address"), \
                                        _("The DHCP end address could not be understood"))

            if enabled and not ip.overlaps(start):
                return self.err.val_err(_("Invalid DHCP Address"), \
                                        _("The DHCP start address is not with the network %s") % (str(ip)))
            if enabled and not ip.overlaps(end):
                return self.err.val_err(_("Invalid DHCP Address"), \
                                        _("The DHCP end address is not with the network %s") % (str(ip)))
        elif page_num == PAGE_FORWARDING:
            if self.window.get_widget("net-forward-dev").get_active():
                dev = self.window.get_widget("net-forward")
                if dev.get_active() == -1:
                    return self.err.val_err(_("Invalid forwarding mode"), \
                                            _("Please select where the traffic should be forwarded"))

        # do this always, since there's no "leaving a notebook page" event.
        self.window.get_widget("create-back").set_sensitive(True)
        return True

    def show_help(self, src_ignore):
        # help to show depends on the notebook page, yahoo
        page = self.window.get_widget("create-pages").get_current_page()
        if page == PAGE_INTRO:
            self.emit("action-show-help", "virt-manager-create-net-intro")
        elif page == PAGE_NAME:
            self.emit("action-show-help", "virt-manager-create-net-name")
        elif page == PAGE_IPV4:
            self.emit("action-show-help", "virt-manager-create-net-ipv4")
        elif page == PAGE_DHCP:
            self.emit("action-show-help", "virt-manager-create-net-dhcp")
        elif page == PAGE_FORWARDING:
            self.emit("action-show-help", "virt-manager-create-net-forwarding")
        elif page == PAGE_SUMMARY:
            self.emit("action-show-help", "virt-manager-create-net-sumary")

vmmGObjectUI.type_register(vmmCreateNetwork)
vmmCreateNetwork.signal_new(vmmCreateNetwork, "action-show-help", [str])