class VumiBridgeTransportConfig(Transport.CONFIG_CLASS): account_key = ConfigText('The account key to connect with.', static=True, required=True) conversation_key = ConfigText('The conversation key to use.', static=True, required=True) access_token = ConfigText('The access token for the conversation key.', static=True, required=True) base_url = ConfigText('The base URL for the API', static=True, default='https://go.vumi.org/api/v1/go/http_api/') message_life_time = ConfigInt('How long to keep message_ids around for.', static=True, default=48 * 60 * 60) # default is 48 hours. redis_manager = ConfigDict("Redis client configuration.", default={}, static=True) max_reconnect_delay = ConfigInt( 'Maximum number of seconds between connection attempts', default=3600, static=True) max_retries = ConfigInt( 'Maximum number of consecutive unsuccessful connection attempts ' 'after which no further connection attempts will be made. If this is ' 'not explicitly set, no maximum is applied', static=True) initial_delay = ConfigFloat('Initial delay for first reconnection attempt', default=0.1, static=True) factor = ConfigFloat( 'A multiplicitive factor by which the delay grows', # (math.e) default=2.7182818284590451, static=True) jitter = ConfigFloat( 'Percentage of randomness to introduce into the delay length' 'to prevent stampeding.', # molar Planck constant times c, joule meter/mole default=0.11962656472, static=True) web_port = ConfigInt( "The port to listen for requests on, defaults to `0`.", default=0, static=True) web_path = ConfigText("The path to listen for inbound requests on.", required=True, static=True) health_path = ConfigText( "The path to listen for downstream health checks on" " (useful with HAProxy)", default='health', static=True)
class MessageForwardingConfig(ApplicationConfig): '''Config for MessageForwardingWorker application worker''' mo_message_url = ConfigText( "The URL to send HTTP POST requests to for MO messages", default=None, static=True) message_queue = ConfigText("The AMQP queue to forward messages on", default=None, static=True) redis_manager = ConfigDict("Redis config.", required=True, static=True) inbound_ttl = ConfigInt( "Maximum time (in seconds) allowed to reply to messages", required=True, static=True) outbound_ttl = ConfigInt( "Maximum time (in seconds) allowed for events to arrive for messages", required=True, static=True) metric_window = ConfigFloat( "Size of the buckets to use (in seconds) for metrics", required=True, static=True)
class MessageForwardingConfig(ApplicationConfig): '''Config for MessageForwardingWorker application worker''' mo_message_url = ConfigUrl( "The URL to send HTTP POST requests to for MO messages", default=None, static=True) mo_message_url_auth_token = ConfigText( "Authorization Token to use for the mo_message_url", default=None, static=True) mo_message_url_timeout = ConfigInt( "Maximum time (in seconds) a mo_message_url is allowed to take " "to process a message", default=10, static=True) event_url_timeout = ConfigInt( "Maximum time (in seconds) an event_url is allowed to take " "to process an event", default=10, static=True) message_queue = ConfigText("The AMQP queue to forward messages on", default=None, static=True) redis_manager = ConfigDict("Redis config.", required=True, static=True) inbound_ttl = ConfigInt( "Maximum time (in seconds) allowed to reply to messages", required=True, static=True) outbound_ttl = ConfigInt( "Maximum time (in seconds) allowed for events to arrive for messages", required=True, static=True) metric_window = ConfigFloat( "Size of the buckets to use (in seconds) for metrics", required=True, static=True)
class SmppTransportConfig(Transport.CONFIG_CLASS): DELIVERY_REPORT_REGEX = ( 'id:(?P<id>\S{,65})' ' +sub:(?P<sub>...)' ' +dlvrd:(?P<dlvrd>...)' ' +submit date:(?P<submit_date>\d*)' ' +done date:(?P<done_date>\d*)' ' +stat:(?P<stat>[A-Z]{7})' ' +err:(?P<err>...)' ' +[Tt]ext:(?P<text>.{,20})' '.*' ) DELIVERY_REPORT_STATUS_MAPPING = { # Output values should map to themselves: 'delivered': 'delivered', 'failed': 'failed', 'pending': 'pending', # SMPP `message_state` values: 'ENROUTE': 'pending', 'DELIVERED': 'delivered', 'EXPIRED': 'failed', 'DELETED': 'failed', 'UNDELIVERABLE': 'failed', 'ACCEPTED': 'delivered', 'UNKNOWN': 'pending', 'REJECTED': 'failed', # From the most common regex-extracted format: 'DELIVRD': 'delivered', 'REJECTD': 'failed', # Currently we will accept this for Yo! TODO: investigate '0': 'delivered', } twisted_endpoint = ConfigClientEndpoint( 'The SMPP endpoint to connect to.', required=True, static=True, fallbacks=[ClientEndpointFallback()]) system_id = ConfigText( 'User id used to connect to the SMPP server.', required=True, static=True) password = ConfigText( 'Password for the system id.', required=True, static=True) system_type = ConfigText( "Additional system metadata that is passed through to the SMPP " "server on connect.", default="", static=True) interface_version = ConfigText( "SMPP protocol version. Default is '34' (i.e. version 3.4).", default="34", static=True) service_type = ConfigText( 'The SMPP service type', default="", static=True) dest_addr_ton = ConfigInt( 'Destination TON (type of number)', default=0, static=True) dest_addr_npi = ConfigInt( 'Destination NPI (number plan identifier). ' 'Default 1 (ISDN/E.164/E.163)', default=1, static=True) source_addr_ton = ConfigInt( 'Source TON (type of number)', default=0, static=True) source_addr_npi = ConfigInt( 'Source NPI (number plan identifier)', default=0, static=True) registered_delivery = ConfigBool( 'Whether or not to request delivery reports', default=True, static=True) smpp_bind_timeout = ConfigInt( 'How long to wait for a succesful bind', default=30, static=True) smpp_enquire_link_interval = ConfigInt( "Number of seconds to delay before reconnecting to the server after " "being disconnected. Default is 5s. Some WASPs, e.g. Clickatell " "require a 30s delay before reconnecting. In these cases a 45s " "initial_reconnect_delay is recommended.", default=55, static=True) initial_reconnect_delay = ConfigInt( 'How long to wait between reconnecting attempts', default=5, static=True) third_party_id_expiry = ConfigInt( 'How long (seconds) to keep 3rd party message IDs around to allow for ' 'matching submit_sm_resp and delivery report messages. Defaults to ' '1 week', default=(60 * 60 * 24 * 7), static=True) delivery_report_regex = ConfigRegex( 'What regex to use for matching delivery reports', default=DELIVERY_REPORT_REGEX, static=True) delivery_report_status_mapping = ConfigDict( "Mapping from delivery report message state to " "(`delivered`, `failed`, `pending`)", static=True, default=DELIVERY_REPORT_STATUS_MAPPING) submit_sm_expiry = ConfigInt( 'How long (seconds) to wait for the SMSC to return with a ' '`submit_sm_resp`. Defaults to 24 hours', default=(60 * 60 * 24), static=True) submit_sm_encoding = ConfigText( 'How to encode the SMS before putting on the wire', static=True, default='utf-8') submit_sm_data_coding = ConfigInt( 'What data_coding value to tell the SMSC we\'re using when putting' 'an SMS on the wire', static=True, default=0) data_coding_overrides = ConfigDict( "Overrides for data_coding character set mapping. This is useful for " "setting the default encoding (0), adding additional undefined " "encodings (such as 4 or 8) or overriding encodings in cases where " "the SMSC is violating the spec (which happens a lot). Keys should " "be integers, values should be strings containing valid Python " "character encoding names.", default={}, static=True) send_long_messages = ConfigBool( "If `True`, messages longer than 254 characters will be sent in the " "`message_payload` optional field instead of the `short_message` " "field. Default is `False`, simply because that maintains previous " "behaviour.", default=False, static=True) send_multipart_sar = ConfigBool( "If `True`, messages longer than 140 bytes will be sent as a series " "of smaller messages with the sar_* parameters set. Default is " "`False`.", default=False, static=True) send_multipart_udh = ConfigBool( "If `True`, messages longer than 140 bytes will be sent as a series " "of smaller messages with the user data headers. Default is `False`.", default=False, static=True) split_bind_prefix = ConfigText( "This is the Redis prefix to use for storing things like sequence " "numbers and message ids for delivery report handling. It defaults " "to `<system_id>@<host>:<port>`. " "*ONLY* if the connection is split into two separate binds for RX " "and TX then make sure this is the same value for both binds. " "This _only_ needs to be done for TX & RX since messages sent via " "the TX bind are handled by the RX bind and they need to share the " "same prefix for the lookup for message ids in delivery reports to " "work.", default='', static=True) throttle_delay = ConfigFloat( "Delay (in seconds) before retrying a message after receiving " "`ESME_RTHROTTLED` or `ESME_RMSGQFUL`.", default=0.1, static=True) COUNTRY_CODE = ConfigText( "Used to translate a leading zero in a destination MSISDN into a " "country code. Default ''", default="", static=True) OPERATOR_PREFIX = ConfigDict( "Nested dictionary of prefix to network name mappings. Default {} " "(set network to 'UNKNOWN'). E.g. { '27': { '27761': 'NETWORK1' }} ", default={}, static=True) OPERATOR_NUMBER = ConfigDict( "Dictionary of source MSISDN to use for each network listed in " "OPERATOR_PREFIX. If a network is not listed, the source MSISDN " "specified by the message sender is used. Default {} (always used the " "from address specified by the message sender). " "E.g. { 'NETWORK1': '27761234567'}", default={}, static=True) redis_manager = ConfigDict( 'How to connect to Redis', default={}, static=True) # TODO: Deprecate these fields when confmodel#5 is done. host = ConfigText( "*DEPRECATED* 'host' and 'port' fields may be used in place of the" " 'twisted_endpoint' field.", static=True) port = ConfigInt( "*DEPRECATED* 'host' and 'port' fields may be used in place of the" " 'twisted_endpoint' field.", static=True) def post_validate(self): long_message_params = ( 'send_long_messages', 'send_multipart_sar', 'send_multipart_udh') set_params = [p for p in long_message_params if getattr(self, p)] if len(set_params) > 1: params = ', '.join(set_params) self.raise_config_error( "The following parameters are mutually exclusive: %s" % params)
class SmppTransportConfig(Transport.CONFIG_CLASS): twisted_endpoint = ConfigClientEndpoint( 'The SMPP endpoint to connect to.', required=True, static=True, fallbacks=[ClientEndpointFallback()]) initial_reconnect_delay = ConfigInt( 'How long (in seconds) to wait between reconnecting attempts. ' 'Defaults to 5 seconds.', default=5, static=True) throttle_delay = ConfigFloat( "Delay (in seconds) before retrying a message after receiving " "`ESME_RTHROTTLED` or `ESME_RMSGQFUL`.", default=0.1, static=True) deliver_sm_decoding_error = ConfigText( 'The error to respond with when we were unable to decode all parts ' 'of a PDU.', default='ESME_RDELIVERYFAILURE', static=True) submit_sm_expiry = ConfigInt( 'How long (in seconds) to wait for the SMSC to return with a ' '`submit_sm_resp`. Defaults to 24 hours.', default=(60 * 60 * 24), static=True) disable_ack = ConfigBool( 'Disable publishing of `ack` events. In some cases this event ' 'causes more noise than signal. It can optionally be turned off. ' 'Defaults to False.', default=False, static=True) third_party_id_expiry = ConfigInt( 'How long (in seconds) to keep 3rd party message IDs around to allow ' 'for matching submit_sm_resp and delivery report messages. Defaults ' 'to 1 week.', default=(60 * 60 * 24 * 7), static=True) final_dr_third_party_id_expiry = ConfigInt( 'How long (in seconds) to keep 3rd party message IDs around after ' 'receiving a success or failure delivery report for the message.', default=(60 * 60), static=True) completed_multipart_info_expiry = ConfigInt( 'How long (in seconds) to keep multipart message info for completed ' 'multipart messages around to avoid pending operations accidentally ' 'recreating them without an expiry time. Defaults to 1 hour.', default=(60 * 60), static=True) redis_manager = ConfigDict('How to connect to Redis.', default={}, static=True) split_bind_prefix = ConfigText( "This is the Redis prefix to use for storing things like sequence " "numbers and message ids for delivery report handling. It defaults " "to `<system_id>@<transport_name>`. " "This should *ONLY* be done for TX & RX since messages sent via " "the TX bind are handled by the RX bind and they need to share the " "same prefix for the lookup for message ids in delivery reports to " "work.", default='', static=True) codec_class = ConfigClassName( 'Which class should be used to handle character encoding/decoding. ' 'MUST implement `IVumiCodec`.', default='vumi.codecs.VumiCodec', static=True, implements=IVumiCodec) delivery_report_processor = ConfigClassName( 'Which delivery report processor to use. ' 'MUST implement `IDeliveryReportProcessor`.', default=('vumi.transports.smpp.processors.' 'DeliveryReportProcessor'), static=True, implements=IDeliveryReportProcessor) delivery_report_processor_config = ConfigDict( 'The configuration for the `delivery_report_processor`.', default={}, static=True) deliver_short_message_processor = ConfigClassName( 'Which deliver short message processor to use. ' 'MUST implement `IDeliverShortMessageProcessor`.', default='vumi.transports.smpp.processors.DeliverShortMessageProcessor', static=True, implements=IDeliverShortMessageProcessor) deliver_short_message_processor_config = ConfigDict( 'The configuration for the `deliver_short_message_processor`.', default={}, static=True) submit_short_message_processor = ConfigClassName( 'Which submit short message processor to use. ' 'Should implements `ISubmitShortMessageProcessor`.', default='vumi.transports.smpp.processors.SubmitShortMessageProcessor', static=True, implements=ISubmitShortMessageProcessor) submit_short_message_processor_config = ConfigDict( 'The configuration for the `submit_short_message_processor`.', default={}, static=True) system_id = ConfigText('User id used to connect to the SMPP server.', required=True, static=True) password = ConfigText('Password for the system id.', required=True, static=True) system_type = ConfigText( "Additional system metadata that is passed through to the SMPP " "server on connect.", default="", static=True) interface_version = ConfigText( "SMPP protocol version. Default is '34' (i.e. version 3.4).", default="34", static=True) service_type = ConfigText('The SMPP service type.', default="", static=True) address_range = ConfigText( "Address range to receive. (SMSC-specific format, default empty.)", default="", static=True) dest_addr_ton = ConfigInt('Destination TON (type of number).', default=0, static=True) dest_addr_npi = ConfigInt( 'Destination NPI (number plan identifier). ' 'Default 1 (ISDN/E.164/E.163).', default=1, static=True) source_addr_ton = ConfigInt('Source TON (type of number).', default=0, static=True) source_addr_npi = ConfigInt('Source NPI (number plan identifier).', default=0, static=True) registered_delivery = ConfigBool( 'Whether or not to request delivery reports. Default True.', default=True, static=True) smpp_bind_timeout = ConfigInt( 'How long (in seconds) to wait for a succesful bind. Default 30.', default=30, static=True) smpp_enquire_link_interval = ConfigInt( "How long (in seconds) to delay before reconnecting to the server " "after being disconnected. Some WASPs, e.g. Clickatell require a 30s " "delay before reconnecting. In these cases a 45s " "`initial_reconnect_delay` is recommended. Default 55.", default=55, static=True) mt_tps = ConfigInt( 'Mobile Terminated Transactions per Second. The Maximum Vumi ' 'messages per second to attempt to put on the wire. ' 'Defaults to 0 which means no throttling is applied. ' '(NOTE: 1 Vumi message may result in multiple PDUs)', default=0, static=True, required=False) # TODO: Deprecate these fields when confmodel#5 is done. host = ConfigText( "*DEPRECATED* 'host' and 'port' fields may be used in place of the" " 'twisted_endpoint' field.", static=True) port = ConfigInt( "*DEPRECATED* 'host' and 'port' fields may be used in place of the" " 'twisted_endpoint' field.", static=True)
class HttpRpcTransportConfig(Transport.CONFIG_CLASS): """Base config definition for transports. You should subclass this and add transport-specific fields. """ web_path = ConfigText("The path to listen for requests on.", static=True) web_port = ConfigInt( "The port to listen for requests on, defaults to `0`.", default=0, static=True) web_username = ConfigText( "The username to require callers to authenticate with. If ``None``" " then no authentication is required. Currently only HTTP Basic" " authentication is supported.", default=None, static=True) web_password = ConfigText( "The password to go with ``web_username``. Must be ``None`` if and" " only if ``web_username`` is ``None``.", default=None, static=True) web_auth_domain = ConfigText("The name of authentication domain.", default="Vumi HTTP RPC transport", static=True) health_path = ConfigText( "The path to listen for downstream health checks on" " (useful with HAProxy)", default='health', static=True) request_cleanup_interval = ConfigInt( "How often should we actively look for old connections that should" " manually be timed out. Anything less than `1` disables the request" " cleanup meaning that all request objects will be kept in memory" " until the server is restarted, regardless if the remote side has" " dropped the connection or not. Defaults to 5 seconds.", default=5, static=True) request_timeout = ConfigInt( "How long should we wait for the remote side generating the response" " for this synchronous operation to come back. Any connection that has" " waited longer than `request_timeout` seconds will manually be" " closed. Defaults to 4 minutes.", default=(4 * 60), static=True) request_timeout_status_code = ConfigInt( "What HTTP status code should be generated when a timeout occurs." " Defaults to `504 Gateway Timeout`.", default=504, static=True) request_timeout_body = ConfigText( "What HTTP body should be returned when a timeout occurs." " Defaults to ''.", default='', static=True) noisy = ConfigBool( "Defaults to `False` set to `True` to make this transport log" " verbosely.", default=False, static=True) validation_mode = ConfigText( "The mode to operate in. Can be 'strict' or 'permissive'. If 'strict'" " then any parameter received that is not listed in EXPECTED_FIELDS" " nor in IGNORED_FIELDS will raise an error. If 'permissive' then no" " error is raised as long as all the EXPECTED_FIELDS are present.", default='strict', static=True) response_time_down = ConfigFloat( "The maximum time allowed for a response before the service is " "considered `down`", default=10.0, static=True) response_time_degraded = ConfigFloat( "The maximum time allowed for a response before the service is " "considered `degraded`", default=1.0, static=True) def post_validate(self): auth_supplied = (self.web_username is None, self.web_password is None) if any(auth_supplied) and not all(auth_supplied): raise ConfigError("If either web_username or web_password is" " specified, both must be specified")