#coding=utf-8 # Copyright (C) 2015, Alibaba Cloud Computing #Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: #The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. #THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. import time import base64 from .mns_client import MNSClient from .mns_request import * from .mns_exception import * from .subscription import * try: import json except ImportError: import simplejson as json class Topic: def __init__(self, topic_name, mns_client, debug=False): self.topic_name = topic_name self.mns_client = mns_client self.debug = debug def set_debug(self, debug): self.debug = debug def get_subscription(self, subscription_name): """ 获取Topic的一个Subscription对象 @type subscription_name: string @param subscription_name: 订阅名称 @rtype: Subscription object @return: 返回该Topic的一个Subscription对象 """ return Subscription(self.topic_name, subscription_name, self.mns_client, self.debug) def create(self, topic_meta, req_info=None): """ 创建主题 @type topic_meta: TopicMeta object @param topic_meta: TopicMeta对象，指定主题的属性 @type req_info: RequestInfo object @param req_info: 透传到MNS的请求信息 @rtype: string @return 新创建队列的URL @note: Exception :: MNSClientParameterException 参数格式异常 :: MNSClientNetworkException 网络异常 :: MNSServerException mns处理异常 """ req = CreateTopicRequest(self.topic_name, topic_meta.maximum_message_size, topic_meta.logging_enabled) req.set_req_info(req_info) resp = CreateTopicResponse() self.mns_client.create_topic(req, resp) self.debuginfo(resp) return resp.topic_url def get_attributes(self, req_info=None): """ 获取主题属性 @type req_info: RequestInfo object @param req_info: 透传到MNS的请求信息 @rtype: TopicMeta object @return 主题的属性 @note: Exception :: MNSClientNetworkException 网络异常 :: MNSServerException mns处理异常 """ req = GetTopicAttributesRequest(self.topic_name) req.set_req_info(req_info) resp = GetTopicAttributesResponse() self.mns_client.get_topic_attributes(req, resp) topic_meta = TopicMeta() self.__resp2meta__(topic_meta, resp) self.debuginfo(resp) return topic_meta def set_attributes(self, topic_meta, req_info=None): """ 设置队列属性 @type topic_meta: TopicMeta object @param topic_meta: 新设置的主题属性 @type req_info: RequestInfo object @param req_info: 透传到MNS的请求信息 @note: Exception :: MNSClientParameterException 参数格式异常 :: MNSClientNetworkException 网络异常 :: MNSServerException mns处理异常 """ req = SetTopicAttributesRequest(self.topic_name, topic_meta.maximum_message_size, topic_meta.logging_enabled) req.set_req_info(req_info) resp = SetTopicAttributesResponse() self.mns_client.set_topic_attributes(req, resp) self.debuginfo(resp) def delete(self, req_info=None): """ 删除主题 @type req_info: RequestInfo object @param req_info: 透传到MNS的请求信息 @note: Exception :: MNSClientNetworkException 网络异常 :: MNSServerException mns处理异常 """ req = DeleteTopicRequest(self.topic_name) req.set_req_info(req_info) resp = DeleteTopicResponse() self.mns_client.delete_topic(req, resp) self.debuginfo(resp) def publish_message(self, message, req_info=None): """ 发送消息 @type message: TopicMessage object @param message: 发布的TopicMessage object @type req_info: RequestInfo object @param req_info: 透传到MNS的请求信息 @rtype: TopicMessage object @return: 消息发布成功的返回属性，包含MessageId和MessageBodyMD5 @note: Exception :: MNSClientParameterException 参数格式异常 :: MNSClientNetworkException 网络异常 :: MNSServerException mns处理异常 """ req = PublishMessageRequest(self.topic_name, message.message_body, message.message_tag, message.direct_mail, message.direct_sms) req.set_req_info(req_info) resp = PublishMessageResponse() self.mns_client.publish_message(req, resp) self.debuginfo(resp) return self.__publish_resp2msg__(resp) def list_subscription(self, prefix = "", ret_number = -1, marker = "", req_info=None): """ 列出该主题的订阅 @type prefix: string @param prefix: 订阅名称的前缀 @type ret_number: int @param ret_number: list_subscription最多返回的订阅个数 @type marker: string @param marker: list_subscriptiond的起始位置，上次list_subscription返回的next_marker @type req_info: RequestInfo object @param req_info: 透传到MNS的请求信息 @rtype: tuple @return SubscriptionURL的列表,下次list subscription的起始位置;当所有订阅都返回时，next_marker为"" @note: Exception :: MNSClientParameterException 参数格式异常 :: MNSClientNetworkException 网络异常 :: MNSServerException mns处理异常 """ req = ListSubscriptionByTopicRequest(self.topic_name, prefix, ret_number, marker) req.set_req_info(req_info) resp = ListSubscriptionByTopicResponse() self.mns_client.list_subscription_by_topic(req, resp) self.debuginfo(resp) return resp.subscriptionurl_list, resp.next_marker def debuginfo(self, resp): if self.debug: print("===================DEBUG INFO===================") print("RequestId: %s" % resp.header["x-mns-request-id"]) print("================================================") def __resp2meta__(self, topic_meta, resp): topic_meta.message_count = resp.message_count topic_meta.create_time = resp.create_time topic_meta.last_modify_time = resp.last_modify_time topic_meta.maximum_message_size = resp.maximum_message_size topic_meta.message_retention_period = resp.message_retention_period topic_meta.topic_name = resp.topic_name topic_meta.logging_enabled = resp.logging_enabled def __publish_resp2msg__(self, resp): msg = TopicMessage() msg.message_id = resp.message_id msg.message_body_md5 = resp.message_body_md5 return msg class TopicMeta: def __init__(self, maximum_message_size = -1, logging_enabled = None): """ 主题属性 @note：设置属性 :: maximum_message_size: message body的最大长度，单位：Byte :: logging_enabled: 是否开启logging功能，如果开启MNS将该主题的日志推送到Account的logging bucket中 @note: 不可设置属性 :: message_retention_period: message最长存活时间，单位：秒 :: message_count: topic中的消息数 :: create_time: topic创建时间，单位：秒 :: last_modify_time: 修改topic属性的最近时间，单位：秒 :: topic_name: 主题名称 """ self.maximum_message_size = maximum_message_size self.logging_enabled = logging_enabled self.message_retention_period = -1 self.message_count = -1 self.create_time = -1 self.last_modify_time = -1 self.topic_name = "" def set_maximum_message_size(self, maximum_message_size): self.maximum_message_size = maximum_message_size def set_logging_enabled(self, logging_enabled): self.logging_enabled = logging_enabled def __str__(self): meta_info = {"MaximumMessageSize": self.maximum_message_size, "MessageRetentionPeriod": self.message_retention_period, "MessageCount": self.message_count, "CreateTime": time.strftime("%Y/%m/%d %H:%M:%S", time.localtime(self.create_time)), "LastModifyTime": time.strftime("%Y/%m/%d %H:%M:%S", time.localtime(self.last_modify_time)), "TopicName": self.topic_name, "LoggingEnabled": self.logging_enabled} return "\n".join(["%s: %s" % (k.ljust(30),v) for k,v in meta_info.items()]) class TopicMessage(object): def __init__(self, message_body = u"", message_tag = u"", direct_mail = None, direct_sms = None): """ Specify information of TopicMessage @note: publish_message params :: message_body string :: message_tag string, used to filter message :: direct_mail DirectMailInfo, the information of direct mail :: direct_sms DirectSMSInfo, the information of direct sms @note: publish_message response information :: message_id :: message_body_md5 """ # None 处理, 避免生成 xml 数据时的 TypeError 以及 base64编码 时的 None 问题 if message_body is None: raise MNSClientParameterException("MessageBodyInvalid", "Bad value: None, message body should not be None.") self.message_body = message_body self.message_tag = message_tag self.direct_mail = direct_mail self.direct_sms = direct_sms self.message_id = u"" self.message_body_md5 = u"" def set_messagebody(self, message_body): self.message_body = message_body def get_messagebody(self): return self.message_body def set_message_tag(self, message_tag): self.message_tag = message_tag class Base64TopicMessage(TopicMessage): def __init__(self, message_body = u"", message_tag = u"", direct_mail = None, direct_sms = None): """ Specify information of Base64TopicMessage @note: publish_message params :: message_body string :: message_tag string, used to filter message :: direct_mail DirectMailInfo, the information of direct mail :: direct_sms DirectSMSInfo, the information of direct sms """ super(Base64TopicMessage, self).__init__(message_body, message_tag, direct_mail, direct_sms) self.message_body = base64.b64encode(self.message_body.encode("utf-8")).decode("utf-8") def set_messagebody(self, message_body): self.message_body = base64.b64encode(message_body.encode("utf-8")).decode("utf-8") def get_messagebody(self): return base64.b64decode(self.message_body.encode("utf-8")).decode("utf-8") class DirectMailInfo: def __init__(self, account_name, subject, address_type, is_html, reply_to_address): """ Specify information of DirectMail @type account_name: string @param account_name: the name of transmission account @type subject: string @param subject: the subject of mail @type address_type: int @param address_type: 0 or 1 @type is_html: int @param is_html: 0 or 1 @type reply_to_address: int @param reply_to_address: 0 or 1 @note: go https://help.aliyun.com/document_detail/29444.html to get more information """ self.account_name = account_name self.subject = subject self.address_type = address_type self.is_html = is_html self.reply_to_address = reply_to_address def get(self): return {"AccountName": self.account_name, \ "Subject": self.subject, \ "AddressType": self.address_type, \ "IsHtml": self.is_html,\ "ReplyToAddress": self.reply_to_address} class DirectSMSInfo: SINGLE_CONTENT = "singleContent" MULTI_CONTENT = "multiContent" def __init__(self, free_sign_name, template_code, single): """ Specify information of DirectSMS @type free_sign name: string @param free_sign_name: the name of sign, you can list from console @type template_code: string @param template_code: the code of template, you can list from console @type single: bool @param single: the type of SMS is singleContent or not """ self.free_sign_name = free_sign_name self.template_code = template_code if single: self.type = DirectSMSInfo.SINGLE_CONTENT else: self.type = DirectSMSInfo.MULTI_CONTENT self.receivers = set([]) self.sms_params = {} def add_receiver(self, receiver, params=None): """ @type receiver: string @param receiver: the phone number of receiver @type params: dict @param params: specify params for receiver, such ad: {"key1":"value1", "key2":"value2"} """ if self.type == DirectSMSInfo.SINGLE_CONTENT: self.receivers.add(receiver) else: if params is not None: self.sms_params[receiver] = params else: self.sms_params[receiver] = {} def set_params(self, params): self.sms_params = params def get(self): info = {"FreeSignName": self.free_sign_name,\ "TemplateCode": self.template_code,\ "Type": self.type,\ "Receiver": ','.join(self.receivers),\ "SmsParams": json.dumps(self.sms_params)} return info