text: #    (c) Copyright 2013 Hewlett-Packard Development Company, L.P.
  #    All Rights Reserved.
  #
  #    Licensed under the Apache License, Version 2.0 (the "License"); you may
  #    not use this file except in compliance with the License. You may obtain
  #    a copy of the License at
  #
  #         http://www.apache.org/licenses/LICENSE-2.0
  #
  #    Unless required by applicable law or agreed to in writing, software
  #    distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
  #    WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
  #    License for the specific language governing permissions and limitations
  #    under the License.
  #
  
  from oslo_serialization import jsonutils
  
  from neutronclient.common import exceptions
  from neutronclient.common import utils
  from neutronclient.i18n import _
  from neutronclient.neutron import v2_0 as neutronv20
  from neutronclient.neutron.v2_0.vpn import utils as vpn_utils
  
  
  def _format_peer_cidrs(ipsec_site_connection):
      try:
          return '\n'.join([jsonutils.dumps(cidrs) for cidrs in
                            ipsec_site_connection['peer_cidrs']])
      except (TypeError, KeyError):
          return ''
  
  
  class ListIPsecSiteConnection(neutronv20.ListCommand):
      """List IPsec site connections that belong to a given tenant."""
  
      resource = 'ipsec_site_connection'
      _formatters = {'peer_cidrs': _format_peer_cidrs}
      list_columns = [
          'id', 'name', 'peer_address', 'peer_cidrs', 'route_mode',
          'auth_mode', 'status']
      pagination_support = True
      sorting_support = True
  
  
  class ShowIPsecSiteConnection(neutronv20.ShowCommand):
      """Show information of a given IPsec site connection."""
  
      resource = 'ipsec_site_connection'
  
  
  class CreateIPsecSiteConnection(neutronv20.CreateCommand):
      """Create an IPsec site connection."""
      resource = 'ipsec_site_connection'
  
      def add_known_arguments(self, parser):
          parser.add_argument(
              '--admin-state-down',
              default=True, action='store_false',
              help=_('Set admin state up to false.'))
          parser.add_argument(
              '--name',
              help=_('Set friendly name for the connection.'))
          parser.add_argument(
              '--description',
              help=_('Set a description for the connection.'))
          parser.add_argument(
              '--mtu',
              default='1500',
              help=_('MTU size for the connection, default:1500'))
          parser.add_argument(
              '--initiator',
              default='bi-directional', choices=['bi-directional',
                                                 'response-only'],
              help=_('Initiator state in lowercase, default:bi-directional'))
          parser.add_argument(
              '--dpd',
              metavar="action=ACTION,interval=INTERVAL,timeout=TIMEOUT",
              type=utils.str2dict,
              help=vpn_utils.dpd_help("IPsec connection."))
          parser.add_argument(
              '--vpnservice-id', metavar='VPNSERVICE',
              required=True,
              help=_('VPN service instance ID associated with this connection.'))
          parser.add_argument(
              '--ikepolicy-id', metavar='IKEPOLICY',
              required=True,
              help=_('IKE policy ID associated with this connection.'))
          parser.add_argument(
              '--ipsecpolicy-id', metavar='IPSECPOLICY',
              required=True,
              help=_('IPsec policy ID associated with this connection.'))
          parser.add_argument(
              '--peer-address',
              required=True,
              help=_('Peer gateway public IPv4/IPv6 address or FQDN.'))
          parser.add_argument(
              '--peer-id',
              required=True,
              help=_('Peer router identity for authentication. Can be '
                     'IPv4/IPv6 address, e-mail address, key id, or FQDN.'))
          parser.add_argument(
              '--peer-cidr',
              action='append', dest='peer_cidrs',
              required=True,
              help=_('Remote subnet(s) in CIDR format.'))
          parser.add_argument(
              '--psk',
              required=True,
              help=_('Pre-shared key string.'))
  
      def args2body(self, parsed_args):
          _vpnservice_id = neutronv20.find_resourceid_by_name_or_id(
              self.get_client(), 'vpnservice',
              parsed_args.vpnservice_id)
          _ikepolicy_id = neutronv20.find_resourceid_by_name_or_id(
              self.get_client(), 'ikepolicy',
              parsed_args.ikepolicy_id)
          _ipsecpolicy_id = neutronv20.find_resourceid_by_name_or_id(
              self.get_client(), 'ipsecpolicy',
              parsed_args.ipsecpolicy_id)
          if int(parsed_args.mtu) < 68:
              message = _("Invalid MTU value: MTU must be "
                          "greater than or equal to 68")
              raise exceptions.CommandError(message)
          body = {
              'vpnservice_id': _vpnservice_id,
              'ikepolicy_id': _ikepolicy_id,
              'ipsecpolicy_id': _ipsecpolicy_id,
              'peer_address': parsed_args.peer_address,
              'peer_id': parsed_args.peer_id,
              'mtu': parsed_args.mtu,
              'initiator': parsed_args.initiator,
              'psk': parsed_args.psk,
              'admin_state_up': parsed_args.admin_state_down,
          }
          if parsed_args.name:
              body['name'] = parsed_args.name
          if parsed_args.description:
              body['description'] = parsed_args.description
          if parsed_args.tenant_id:
              body['tenant_id'] = parsed_args.tenant_id
          if parsed_args.dpd:
              vpn_utils.validate_dpd_dict(parsed_args.dpd)
              body['dpd'] = parsed_args.dpd
          if parsed_args.peer_cidrs:
              body['peer_cidrs'] = parsed_args.peer_cidrs
  
          return {'ipsec_site_connection': body}
  
  
  class UpdateIPsecSiteConnection(neutronv20.UpdateCommand):
      """Update a given IPsec site connection."""
  
      resource = 'ipsec_site_connection'
  
      def add_known_arguments(self, parser):
  
          parser.add_argument(
              '--dpd',
              metavar="action=ACTION,interval=INTERVAL,timeout=TIMEOUT",
              type=utils.str2dict,
              help=vpn_utils.dpd_help("IPsec connection."))
  
      def args2body(self, parsed_args):
          body = {}
          if parsed_args.dpd:
              vpn_utils.validate_dpd_dict(parsed_args.dpd)
              body['dpd'] = parsed_args.dpd
          return {'ipsec_site_connection': body}
  
  
  class DeleteIPsecSiteConnection(neutronv20.DeleteCommand):
      """Delete a given IPsec site connection."""
  
      resource = 'ipsec_site_connection'
  