class UserAccountV1(Model): """A user account.""" bucket = "useraccount" VERSION = 1 MIGRATOR = UserAccountMigrator # key is uuid username = Unicode(max_length=255) # TODO: tagpools can be made OneToMany once vumi.persist.fields # gains a OneToMany field tagpools = ManyToMany(UserTagPermissionVNone) applications = ManyToMany(UserAppPermissionVNone) created_at = Timestamp(default=datetime.utcnow) event_handler_config = Json(default=list) msisdn = Unicode(max_length=255, null=True) confirm_start_conversation = Boolean(default=False) # `tags` is allowed to be null so that we can detect freshly-migrated # accounts and populate the tags from active conversations. A new account # has no legacy tags or conversations, so we start with an empty list and # skip the tag collection. tags = Json(default=[], null=True) @Manager.calls_manager def has_tagpool_permission(self, tagpool): for tp_bunch in self.tagpools.load_all_bunches(): for tp in (yield tp_bunch): if tp.tagpool == tagpool: returnValue(True) returnValue(False)
class UserAccountV4(Model): """A user account.""" VERSION = 4 # key is uuid username = Unicode(max_length=255) # TODO: tagpools can be made OneToMany once vumi.persist.fields # gains a OneToMany field tagpools = ManyToMany(UserTagPermissionVNone) applications = ManyToMany(UserAppPermissionVNone) created_at = Timestamp(default=datetime.utcnow) event_handler_config = Json(default=list) msisdn = Unicode(max_length=255, null=True) confirm_start_conversation = Boolean(default=False) can_manage_optouts = Boolean(default=False) email_summary = Unicode(max_length=255, null=True) tags = Json(default=[]) routing_table = RoutingTableField(default=RoutingTable({})) @Manager.calls_manager def has_tagpool_permission(self, tagpool): for tp_bunch in self.tagpools.load_all_bunches(): for tp in (yield tp_bunch): if tp.tagpool == tagpool: returnValue(True) returnValue(False)
class UserAccountVNone(Model): """A user account.""" bucket = "useraccount" # key is uuid username = Unicode(max_length=255) # TODO: tagpools can be made OneToMany once vumi.persist.fields # gains a OneToMany field tagpools = ManyToMany(UserTagPermissionVNone) applications = ManyToMany(UserAppPermissionVNone) created_at = Timestamp(default=datetime.utcnow) event_handler_config = Json(null=True) msisdn = Unicode(max_length=255, null=True) confirm_start_conversation = Boolean(default=False)
class OutboundMessage(Model): VERSION = 5 MIGRATOR = OutboundMessageMigrator # key is message_id msg = VumiMessage(TransportUserMessage) batches = ManyToMany(Batch) # Extra fields for compound indexes batches_with_addresses = ListOf(Unicode(), index=True) batches_with_addresses_reverse = ListOf(Unicode(), index=True) def save(self): # We override this method to set our index fields before saving. self.batches_with_addresses = [] self.batches_with_addresses_reverse = [] timestamp = self.msg['timestamp'] if not isinstance(timestamp, basestring): timestamp = format_vumi_date(timestamp) reverse_ts = to_reverse_timestamp(timestamp) for batch_id in self.batches.keys(): self.batches_with_addresses.append( u"%s$%s$%s" % (batch_id, timestamp, self.msg['to_addr'])) self.batches_with_addresses_reverse.append( u"%s$%s$%s" % (batch_id, reverse_ts, self.msg['to_addr'])) return super(OutboundMessage, self).save()
class Event(Model): VERSION = 2 MIGRATOR = EventMigrator # key is event_id event = VumiMessage(TransportEvent) message = ForeignKey(OutboundMessage) batches = ManyToMany(Batch) # Extra fields for compound indexes message_with_status = Unicode(index=True, null=True) batches_with_statuses_reverse = ListOf(Unicode(), index=True) def save(self): # We override this method to set our index fields before saving. timestamp = self.event['timestamp'] if not isinstance(timestamp, basestring): timestamp = format_vumi_date(timestamp) status = self.event['event_type'] if status == "delivery_report": status = "%s.%s" % (status, self.event['delivery_status']) self.message_with_status = u"%s$%s$%s" % (self.message.key, timestamp, status) self.batches_with_statuses_reverse = [] reverse_ts = to_reverse_timestamp(timestamp) for batch_id in self.batches.keys(): self.batches_with_statuses_reverse.append( u"%s$%s$%s" % (batch_id, reverse_ts, status)) return super(Event, self).save()
class InboundMessageV3(Model): bucket = 'inboundmessage' VERSION = 3 MIGRATOR = InboundMessageMigrator # key is message_id msg = VumiMessage(TransportUserMessage) batches = ManyToMany(BatchVNone) # Extra fields for compound indexes batches_with_timestamps = ListOf(Unicode(), index=True) batches_with_addresses = ListOf(Unicode(), index=True) def save(self): # We override this method to set our index fields before saving. batches_with_timestamps = [] batches_with_addresses = [] timestamp = self.msg['timestamp'] for batch_id in self.batches.keys(): batches_with_timestamps.append(u"%s$%s" % (batch_id, timestamp)) batches_with_addresses.append( u"%s$%s$%s" % (batch_id, timestamp, self.msg['from_addr'])) self.batches_with_timestamps = batches_with_timestamps self.batches_with_addresses = batches_with_addresses return super(InboundMessageV3, self).save()
class ContactV1(Model): """A contact""" bucket = "contact" VERSION = 1 MIGRATOR = ContactMigrator # key is UUID user_account = ForeignKey(UserAccount) name = Unicode(max_length=255, null=True) surname = Unicode(max_length=255, null=True) email_address = Unicode(null=True) # EmailField? msisdn = Unicode(max_length=255) dob = Timestamp(null=True) twitter_handle = Unicode(max_length=100, null=True) facebook_id = Unicode(max_length=100, null=True) bbm_pin = Unicode(max_length=100, null=True) gtalk_id = Unicode(null=True) mxit_id = Unicode(null=True) wechat_id = Unicode(null=True) created_at = Timestamp(default=datetime.utcnow) groups = ManyToMany(ContactGroupVNone) extra = Dynamic(prefix='extras-') subscription = Dynamic(prefix='subscription-') def add_to_group(self, group): if isinstance(group, ContactGroupVNone): self.groups.add(group) else: self.groups.add_key(group) def addr_for(self, delivery_class): if delivery_class is None: # FIXME: Find a better way to do get delivery_class and get rid of # this hack. return self.msisdn # TODO: delivery classes need to be defined somewhere if delivery_class in ('sms', 'ussd'): return self.msisdn elif delivery_class == 'gtalk': return self.gtalk_id elif delivery_class == 'twitter': return self.twitter_handle elif delivery_class == 'mxit': return self.mxit_id elif delivery_class == 'wechat': return self.wechat_id else: return None def __unicode__(self): if self.name and self.surname: return u' '.join([self.name, self.surname]) else: return (self.surname or self.name or self.gtalk_id or self.twitter_handle or self.msisdn or self.mxit_id or self.wechat_id or 'Unknown User')
class InboundMessage(Model): VERSION = 1 MIGRATOR = InboundMessageMigrator # key is message_id msg = VumiMessage(TransportUserMessage) batches = ManyToMany(Batch)
class InboundMessageV1(Model): bucket = 'inboundmessage' VERSION = 1 MIGRATOR = InboundMessageMigrator # key is message_id msg = VumiMessage(TransportUserMessage) batches = ManyToMany(BatchVNone)
class Contact(Model): """A contact""" VERSION = 2 MIGRATOR = ContactMigrator # key is UUID user_account = ForeignKey(UserAccount) name = Unicode(max_length=255, null=True) surname = Unicode(max_length=255, null=True) email_address = Unicode(null=True) # EmailField? dob = Timestamp(null=True) created_at = Timestamp(default=datetime.utcnow) groups = ManyToMany(ContactGroup) extra = Dynamic(prefix='extras-') subscription = Dynamic(prefix='subscription-') # Address fields msisdn = Unicode(max_length=255, index=True) twitter_handle = Unicode(max_length=100, null=True, index=True) facebook_id = Unicode(max_length=100, null=True, index=True) bbm_pin = Unicode(max_length=100, null=True, index=True) gtalk_id = Unicode(null=True, index=True) mxit_id = Unicode(null=True, index=True) wechat_id = Unicode(null=True, index=True) def add_to_group(self, group): if isinstance(group, ContactGroup): self.groups.add(group) else: self.groups.add_key(group) def addr_for(self, delivery_class): if delivery_class is None: # FIXME: Find a better way to do get delivery_class and get rid of # this hack. return self.msisdn delivery_class = DELIVERY_CLASSES.get(delivery_class) if delivery_class is not None: return getattr(self, delivery_class['field']) return None def __unicode__(self): if self.name and self.surname: return u' '.join([self.name, self.surname]) else: return (self.surname or self.name or self.gtalk_id or self.twitter_handle or self.msisdn or self.mxit_id or self.wechat_id or 'Unknown User')
class OutboundMessage(Model): VERSION = 3 MIGRATOR = OutboundMessageMigrator # key is message_id msg = VumiMessage(TransportUserMessage) batches = ManyToMany(Batch) # Extra fields for compound indexes batches_with_timestamps = ListOf(Unicode(), index=True) batches_with_addresses = ListOf(Unicode(), index=True) def save(self): # We override this method to set our index fields before saving. batches_with_timestamps = [] batches_with_addresses = [] timestamp = format_vumi_date(self.msg['timestamp']) for batch_id in self.batches.keys(): batches_with_timestamps.append(u"%s$%s" % (batch_id, timestamp)) batches_with_addresses.append( u"%s$%s$%s" % (batch_id, timestamp, self.msg['to_addr'])) self.batches_with_timestamps = batches_with_timestamps self.batches_with_addresses = batches_with_addresses return super(OutboundMessage, self).save()
class ManyToManyModel(Model): simples = ManyToMany(SimpleModel)
class Conversation(Model): """A conversation with an audience""" VERSION = 3 MIGRATOR = ConversationMigrator user_account = ForeignKey(UserAccount) name = Unicode(max_length=255) description = Unicode(default=u'') conversation_type = Unicode(index=True) config = Json(default=dict) extra_endpoints = ListOf(Unicode()) created_at = Timestamp(default=datetime.utcnow, index=True) archived_at = Timestamp(null=True, index=True) archive_status = Unicode(default=CONVERSATION_ACTIVE, index=True) status = Unicode(default=CONVERSATION_STOPPED, index=True) groups = ManyToMany(ContactGroup) batch = ForeignKey(Batch) delivery_class = Unicode(null=True) def active(self): return self.archive_status == CONVERSATION_ACTIVE def archived(self): return self.archive_status == CONVERSATION_ARCHIVED def ended(self): # TODO: Get rid of this once the old UI finally goes away. return self.archived() def starting(self): return self.status == CONVERSATION_STARTING def running(self): return self.status == CONVERSATION_RUNNING def stopping(self): return self.status == CONVERSATION_STOPPING def stopped(self): return self.status == CONVERSATION_STOPPED def is_draft(self): # TODO: Get rid of this once the old UI finally goes away. return self.active() and self.status == CONVERSATION_STOPPED def get_status(self): """Get the status of this conversation. Possible values are: * CONVERSATION_STARTING * CONVERSATION_RUNNING * CONVERSATION_STOPPING * CONVERSATION_STOPPED :rtype: str """ return self.status # The following are to keep the implementation of this stuff in the model # rather than potentially multiple external places. def set_status_starting(self): self.status = CONVERSATION_STARTING def set_status_started(self): self.status = CONVERSATION_RUNNING def set_status_stopping(self): self.status = CONVERSATION_STOPPING def set_status_stopped(self): self.status = CONVERSATION_STOPPED def set_status_finished(self): self.archive_status = CONVERSATION_ARCHIVED def add_group(self, group): if isinstance(group, ContactGroup): self.groups.add(group) else: self.groups.add_key(group) def __unicode__(self): return self.name def get_contacts_addresses(self, contacts): """ Get the contacts assigned to this group with an address attribute that is appropriate for this conversation's delivery_class """ addrs = [contact.addr_for(self.delivery_class) for contact in contacts] return [addr for addr in addrs if addr] def get_connector(self): return GoConnector.for_conversation(self.conversation_type, self.key)
class ConversationV1(Model): """A conversation with an audience""" VERSION = 1 MIGRATOR = ConversationMigrator bucket = 'conversation' user_account = ForeignKey(UserAccount) name = Unicode(max_length=255) description = Unicode(default=u'') conversation_type = Unicode(index=True) config = Json(default=dict) created_at = Timestamp(default=datetime.utcnow, index=True) start_timestamp = Timestamp(index=True) end_timestamp = Timestamp(null=True, index=True) status = Unicode(default=CONVERSATION_DRAFT, index=True) groups = ManyToMany(ContactGroup) batches = ManyToMany(Batch) delivery_class = Unicode(null=True) delivery_tag_pool = Unicode(null=True) delivery_tag = Unicode(null=True) def started(self): return self.running() or self.ended() def ended(self): return self.status == CONVERSATION_FINISHED def running(self): return self.status == CONVERSATION_RUNNING def get_status(self): """ Get the status of this conversation :rtype: str, (CONVERSATION_FINISHED, CONVERSATION_RUNNING, or CONVERSATION_DRAFT) """ return self.status # The following are to keep the implementation of this stuff in the model # rather than potentially multiple external places. def set_status_started(self): self.status = CONVERSATION_RUNNING def set_status_finished(self): self.status = CONVERSATION_FINISHED def add_group(self, group): if isinstance(group, ContactGroup): self.groups.add(group) else: self.groups.add_key(group) def __unicode__(self): return self.name def get_contacts_addresses(self, contacts): """ Get the contacts assigned to this group with an address attribute that is appropriate for this conversation's delivery_class """ addrs = [contact.addr_for(self.delivery_class) for contact in contacts] return [addr for addr in addrs if addr] def get_routing_name(self): return ':'.join((self.conversation_type, self.key))
class ConversationVNone(Model): """A conversation with an audience""" MIGRATOR = ConversationMigrator bucket = 'conversation' user_account = ForeignKey(UserAccount) subject = Unicode(max_length=255) message = Unicode() start_timestamp = Timestamp() end_timestamp = Timestamp(null=True, index=True) created_at = Timestamp(default=datetime.utcnow) groups = ManyToMany(ContactGroup) conversation_type = Unicode() delivery_class = Unicode(null=True) delivery_tag_pool = Unicode(null=True) delivery_tag = Unicode(null=True) batches = ManyToMany(Batch) metadata = Json(null=True) def started(self): # TODO: Better way to tell if we've started than looking for batches. return bool(self.batches.keys()) def ended(self): return self.end_timestamp is not None def running(self): return self.started() and not self.ended() def get_status(self): """ Get the status of this conversation :rtype: str, (CONVERSATION_FINISHED, CONVERSATION_RUNNING, or CONVERSATION_DRAFT) """ if self.ended(): return CONVERSATION_FINISHED elif self.running(): return CONVERSATION_RUNNING else: return CONVERSATION_DRAFT def add_group(self, group): if isinstance(group, ContactGroup): self.groups.add(group) else: self.groups.add_key(group) def __unicode__(self): return self.subject def get_contacts_addresses(self, contacts): """ Get the contacts assigned to this group with an address attribute that is appropriate for this conversation's delivery_class """ addrs = [contact.addr_for(self.delivery_class) for contact in contacts] return [addr for addr in addrs if addr]
class ManyToManyModel(Model): references = ManyToMany(ReferencedModel)