Skip to content

erp5
erp5
Commit 1d43440d authored by François-Xavier Algrain's avatar François-Xavier Algrain
Browse files
Options

Add documentation. Use sender_title when possible 

Remove not used document

git-svn-id: https://svn.erp5.org/repos/experimental@1966 bc57dcba-3610-0410-ab4f-dc20bb96b918
parent eed8f4f7
Hide whitespace changes
Inline Side-by-side
Showing with 23 additions and 148 deletions
product/ERP5ShortMessage/Document/EssendexGateway.py
View file @ 1d43440d
......@@ -101,11 +101,21 @@ class EssendexGateway(XMLObject):
return phone
security.declareProtected(Permissions.ManagePortal, 'send')
def send(self, text,recipient,sender=None, message_type="text",test=False,**kw):
def send(self, text,recipient,sender=None, sender_title=None,
message_type="text",test=False,**kw):
"""Send a message.
Return message id (or list if multiple recipient)
Parameters:
text -- message
recipient -- phone url of destination_reference. Could be a list
sender -- phone url of source
sender_title -- Use it as source if the gateway has title mode enable
message_type -- Only 'text' is available today
test -- Force the test mode
Kw Parameters:
validity_period -- Validity Period of SMS (default,0)
Return message id (or list if multiple recipient)
"""
if message_type not in self.getAllowedMessageType():
......@@ -128,13 +138,19 @@ class EssendexGateway(XMLObject):
'ValidityPeriod': validity_period,
'PlainText': 1,
}
if sender:
if sender_title and self.isTitleMode():
params['Originator'] = sender_title
elif sender:
params['Originator'] = self._transformPhoneUrlToGatewayNumber(sender)
else:
elif self.getDefaultSender():
params['Originator'] = self.getDefaultSender()
if test or self.isSimulationMode():
params['Test'] = 1
LOG("EssendexGateway", INFO, params)
params = urllib.urlencode(params)
page = urllib.urlopen(base_url, params)
......@@ -246,9 +262,8 @@ class EssendexGateway(XMLObject):
return "+%s(%s)-%s" % (number[0:2],0,number[2:])
#Create the new sms in activities
module = self.getDefaultModule("Short Message")
module.activate(activity='SQLQueue').SMSTool_pushNewSMS(
#Create the new sms in activities
self.activate(activity='SQLQueue').SMSTool_pushNewSMS(
message_id=xml['MessageId'],
sender=parsePhoneNumber(xml['From']),
recipient=parsePhoneNumber(xml['To']),
......@@ -274,8 +289,7 @@ class EssendexGateway(XMLObject):
#Convert date to DateTime
xml['OccurredAt'] = DateTime(xml['OccurredAt'][0:19])
module = self.getDefaultModule("Short Message")
module.activate(activity='SQLQueue').EventModule_setEventDelivery(
self.activate(activity='SQLQueue').SMSTool_setMessageDelivery(
portal_type="Short Message",
destination_reference=xml['MessageId'],
delivery_date=xml['OccurredAt'])
product/ERP5ShortMessage/Document/ShortMessageDocument.py deleted 100644 → 0
View file @ eed8f4f7
##############################################################################
#
# Copyright (c) 2010 Nexedi SA and Contributors. All Rights Reserved.
# Francois-Xavier Algrain <fxalgrain@tiolive.com>
#
# WARNING: This program as such is intended to be used by professional
# programmers who take the whole responsability of assessing all potential
# consequences resulting from its eventual inadequacies and bugs
# End users who are looking for a ready-to-use solution with commercial
# garantees and support are strongly adviced to contract a Free Software
# Service Company
#
# 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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
#
##############################################################################
from AccessControl import ClassSecurityInfo
from Products.ERP5Type.Accessor.Constant import PropertyGetter as ConstantGetter
from Products.ERP5Type import Permissions, PropertySheet
from Products.ERP5.Document.Event import Event
class ShortMessageDocument(Event):
"""
Base class for SMS. Sms are a special Event.
They use a SMS gateway to be sended.
"""
meta_type = 'ERP5 Short Message'
portal_type = 'Short Message'
isDelivery = ConstantGetter('isDelivery', value=True)
# Declarative properties
property_sheets = ( PropertySheet.Base
, PropertySheet.XMLObject
, PropertySheet.CategoryCore
, PropertySheet.Document
, PropertySheet.DublinCore
, PropertySheet.Task
, PropertySheet.Url
, PropertySheet.TextDocument
, PropertySheet.Arrow
, PropertySheet.Movement
, PropertySheet.Event
, PropertySheet.Delivery
, PropertySheet.ItemAggregation
)
# Declarative security
security = ClassSecurityInfo()
security.declareObjectProtected(Permissions.AccessContentsInformation)
security.declareProtected(Permissions.AccessContentsInformation,
'getQuantity')
def getQuantity(self):
"""Get quantity of sms sended"""
#XXX-Fx : See with JPS for a new event implementation
#XXX-Fx : DestinationReference property must be replace by a category
return len(self.getDestinationList())
security.declareProtected(Permissions.UseMailhostServices,
'isDelivered')
def isDelivered(self):
"""Query if message is devivered or not"""
message_quantity = self.getQuantity()
portal = self.portal_sms
if message_quantity == 0:
return None
#XXX-Fx : See with JPS for a new event implementation
#XXX-Fx : DestinationReference property must be replace by a category
status_list = [portal.getMessagesStatus(message_id) for message_id in self.getDestinationReference().split(',')]
for status in status_list:
if status != 'delivered':
return False
return True
security.declareProtected(Permissions.UseMailhostServices, 'send')
def send(self, from_url=None, to_url=None, reply_url=None, subject=None,
body=None, attachment_format=None, attachment_list=None,
download=False,**kw):
"""
Send the current sms by using a SMS gateway.
Use default mobile phone of source and destination
"""
#Get the portal
portal = self.portal_sms
#Get recipients
if not to_url:
recipient_phone_list = [person.getDefaultMobileTelephoneValue() for person in self.getDestinationValueList()]
if None in recipient_phone_list:
raise ValueError, "All recipients should have a default mobile phone"
to_url = [phone.asURL() for phone in recipient_phone_list]
if None in to_url:
raise ValueError, "All recipients should have a valid default mobile phone number"
#Get sender
if not from_url:
if self.getSourceValue():
sender_phone = self.getSourceValue().getDefaultMobileTelephoneValue()
if not sender_phone:
raise ValueError, "The sender should have a default mobile phone"
#We use the title as sender
if sender_phone.getTitle() and portal.isSendByTitleAllowed():
from_url = sender_phone.getTitle()
else:
from_url = sender_phone.asURL()
if not body:
body = self.getTextContent()
#We get the id of the message to track it
#We only send Text message today
message_id_list = portal.send(text=body, recipient=to_url, sender=from_url,message_type="text", test=download)
#set message id to be able to query the status
#XXX-Fx : See with JPS for a new event implementation
#XXX-Fx : DestinationReference property must be replace by a category
if message_id_list is not None:
self.setDestinationReference(",".join(message_id_list))
return message_id_list
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment
GitLab Nexedi Edition | About GitLab | About Nexedi | 沪ICP备2021021310号-2 | 沪ICP备2021021310号-7