blob: 63abda6ab8119c8f2fe3115033f89d4fc3aed6d8 [file] [log] [blame]
# Copyright (c) 2012 The Chromium Authors. All rights reserved.
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.
"""Class to control the BuffaloAP router."""
import logging
import time
import urlparse
import dynamic_ap_configurator
import ap_spec
from selenium.common.exceptions import TimeoutException as \
SeleniumTimeoutException
class BuffaloAPConfigurator(
dynamic_ap_configurator.DynamicAPConfigurator):
"""Configurator for Buffalo AP."""
def __init__(self, ap_config):
super(BuffaloAPConfigurator, self).__init__(ap_config)
self._dhcp_delay = 30
def get_number_of_pages(self):
return 2
def is_update_interval_supported(self):
"""
Returns True if setting the PSK refresh interval is supported.
@return True is supported; False otherwise
"""
return True
def get_supported_modes(self):
return [{'band':ap_spec.BAND_2GHZ,
'modes':[ap_spec.MODE_B, ap_spec.MODE_G, ap_spec.MODE_N,
ap_spec.MODE_B | ap_spec.MODE_G,
ap_spec.MODE_N | ap_spec.MODE_G]}]
def get_supported_bands(self):
return [{'band':ap_spec.BAND_2GHZ,
'channels':[1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11]}]
def is_security_mode_supported(self, security_mode):
"""
Returns if a given security_type is supported.
@param security_mode: one security modes defined in the APSpec
@return True if the security mode is supported; False otherwise.
"""
return security_mode in (ap_spec.SECURITY_TYPE_DISABLED,
ap_spec.SECURITY_TYPE_WPAPSK,
ap_spec.SECURITY_TYPE_WPA2PSK,
ap_spec.SECURITY_TYPE_WEP)
def navigate_to_page(self, page_number):
"""
Navigates to the page corresponding to the given page number.
This method performs the translation between a page number and a url to
load. This is used internally by apply_settings.
@param page_number: page number of the page to load
"""
if page_number == 1:
page_url = urlparse.urljoin(self.admin_interface_url,
'Wireless_Basic.asp')
self.get_url(page_url, page_title='DD-WRT')
elif page_number == 2:
page_url = urlparse.urljoin(self.admin_interface_url,
'WL_WPATable.asp')
self.get_url(page_url, page_title='DD-WRT')
else:
raise RuntimeError('Invalid page number passed. Number of pages '
'%d, page value sent was %d' %
(self.get_number_of_pages(), page_number))
def save_page(self, page_number):
"""
Saves the given page.
@param page_number: Page number of the page to save.
"""
apply_set = '//input[@name="apply_button"]'
try:
self.wait_for_object_by_xpath(apply_set, wait_time=30)
except SeleniumTimeoutException as e:
self.driver.refresh()
self.wait_for_object_by_xpath(apply_set, wait_time=30)
self.click_button_by_xpath(apply_set)
timeout = 0
while self.object_by_xpath_exist("ddwrt_message") and timeout < 60:
time.sleep(1)
timeout = timeout + 1
self._retry_page(page_number)
def _retry_page(self, page_number):
"""Sometimes the interface goes down, retry."""
for i in range(3):
if self.driver.title.find('DD-WRT') == -1:
self.navigate_to_page(page_number)
else:
return
def _wait_for_item_in_popup(self, item, popup):
"""Wait for the popup to be enumerated."""
for i in range(3):
self.wait_for_object_by_xpath(popup)
if self.item_in_popup_by_xpath_exist(item, popup):
break
else:
time.sleep(1)
def set_mode(self, mode, band=None):
self.add_item_to_command_list(self._set_mode, (mode,), 1, 900)
def _set_mode(self, mode):
# Bands are not supported, so ignore.
# Create the mode to popup item mapping.
mode_mapping = {ap_spec.MODE_B:'B-Only', ap_spec.MODE_G: 'G-Only',
ap_spec.MODE_N:'N-Only (2.4 GHz)',
ap_spec.MODE_M:'Mixed',
ap_spec.MODE_B | ap_spec.MODE_G:'BG-Mixed',
ap_spec.MODE_N | ap_spec.MODE_G:'NG-Mixed'}
mode_name = ''
if mode in mode_mapping:
mode_name = mode_mapping[mode]
else:
raise RuntimeError('The mode %d not supported by router %s. ',
hex(mode), self.name)
xpath = '//select[@name="ath0_net_mode"]'
try:
self.select_item_from_popup_by_xpath(mode_name, xpath)
except SeleniumTimeoutException, e:
self.driver.refresh()
self.select_item_from_popup_by_xpath(mode_name, xpath)
def set_radio(self, enabled):
# We cannot turn off radio on Buffalo.
logging.debug('This router (%s) does not support radio.', self.name)
return None
def set_ssid(self, ssid):
self.add_item_to_command_list(self._set_ssid, (ssid,), 1, 900)
def _set_ssid(self, ssid):
xpath = '//input[@maxlength="32" and @name="ath0_ssid"]'
self.set_content_of_text_field_by_xpath(ssid, xpath)
self._ssid = ssid
def set_channel(self, channel):
self.add_item_to_command_list(self._set_channel, (channel,), 1, 900)
def _set_channel(self, channel):
position = self._get_channel_popup_position(channel)
channel_choices = ['1 - 2412 MHz', '2 - 2417 MHz', '3 - 2422 MHz',
'4 - 2427 MHz', '5 - 2432 MHz', '6 - 2437 MHz',
'7 - 2442 MHz', '8 - 2447 MHz', '9 - 2452 MHz',
'10 - 2457 MHz', '11 - 2462 MHz']
xpath = '//select[@name="ath0_channel"]'
if self.number_of_items_in_popup_by_xpath(xpath) == 0:
# If the popup is empty, refresh.
self.driver.refresh()
self.select_item_from_popup_by_xpath(channel_choices[position], xpath)
def set_ch_width(self, channel_width):
"""
Adjusts the channel channel width.
@param channel_width: the channel width
"""
self.add_item_to_command_list(self._set_ch_width,(channel_width,), 1,
900)
def _set_ch_width(self, channel_width):
channel_width_choice=['Full (20 MHz)', 'Half (10 MHz)',
'Quarter (5 MHz)']
xpath = '//select[@name="ath0_channelbw"]'
self.select_item_from_popup_by_xpath(
channel_width_choice[channel_width], xpath)
def set_wireless_mode(self, wireless_mo):
"""
Queues a change to the wireless mode.
@param wireless_mo: the wireless mode.
"""
self.add_item_to_command_list(self._set_wireless_mode,
(wireless_mo,), 1, 900)
def _set_wireless_mode(self, wireless_mo):
"""
Sets the wireless mode.
@param wireless_mo: the wireless mode.
"""
wireless_mode_choices = ['AP', 'Client', 'Client Bridge',
'Adhoc', 'WDS Station', 'WDS AP']
xpath = '//select[@name="ath0_mode"]'
self.select_item_from_popup_by_xpath(wireless_mode_choices[wireless_mo],
xpath)
def set_band(self, band):
logging.debug('This router (%s) does not support multiple bands.',
self.name)
return None
def set_security_disabled(self):
self.add_item_to_command_list(self._set_security_disabled, (), 2, 1000)
def _set_security_disabled(self):
self._retry_page(2)
popup = '//select[@name="ath0_security_mode"]'
disabled_item = 'Disabled'
self._wait_for_item_in_popup(disabled_item, popup)
self.select_item_from_popup_by_xpath(disabled_item, popup)
for i in range(3):
if (self.object_by_xpath_exist('//input[@name="ath0_passphrase"]')
or self.object_by_xpath_exist('//input[@name="ath0_wpa_psk"]')):
time.sleep(1)
else:
break
def set_security_wep(self, key_value, authentication):
self.add_item_to_command_list(self._set_security_wep,
(key_value, authentication), 2, 1000)
def _set_security_wep(self, key_value, authentication):
# Buffalo supports WEP with wireless network mode N.
# No exception is thrown for N-mode with WEP security.
self._retry_page(2)
popup = '//select[@name="ath0_security_mode"]'
text_field = '//input[@name="ath0_passphrase"]'
wep_item = 'WEP'
self._wait_for_item_in_popup(wep_item, popup)
self.select_item_from_popup_by_xpath('WEP', popup,
wait_for_xpath=text_field)
self.wait_for_object_by_xpath(text_field)
self.set_content_of_text_field_by_xpath(key_value, text_field,
abort_check=True)
self.click_button_by_xpath('//input[@value="Generate"]')
def set_security_wpapsk(self, security, shared_key, update_interval=3600):
self.add_item_to_command_list(self._set_security_wpapsk,
(security, shared_key, update_interval),
2, 900)
def _set_security_wpapsk(self, security, shared_key, update_interval=3600):
self._retry_page(2)
popup = '//select[@name="ath0_security_mode"]'
key_field = '//input[@name="ath0_wpa_psk"]'
interval_field = '//input[@name="ath0_wpa_gtk_rekey"]'
if security == ap_spec.SECURITY_TYPE_WPAPSK:
wpa_item = 'WPA Personal'
else:
wpa_item = 'WPA2 Personal'
self._wait_for_item_in_popup(wpa_item, popup)
self.select_item_from_popup_by_xpath(wpa_item, popup)
self.wait_for_object_by_xpath(key_field, wait_time=30)
self.set_content_of_text_field_by_xpath(shared_key, key_field)
self.wait_for_object_by_xpath(interval_field)
self.set_content_of_text_field_by_xpath(str(update_interval),
interval_field)
def set_visibility(self, visible=True):
self.add_item_to_command_list(self._set_visibility, (visible,), 1, 900)
def _set_visibility(self, visible=True):
int_value = 0 if visible else 1
xpath = '//input[@value="%d" and @name="ath0_closed"]' % int_value
self.click_button_by_xpath(xpath)