assembl.models.notification module

Allow users to be notified of certain events happening in a discussion. Depends on subscribing to those events.

exception assembl.models.notification.MissingEmailException

Bases: Exception

class assembl.models.notification.ModelEventWatcherNotificationSubscriptionDispatcher

Bases: assembl.lib.model_watcher.BaseModelEventWatcher

Calls NotificationSubscription.process() on the appropriate NotificationSubscription subclass when a certain CRUD event is detected through the assembl.lib.model_watcher.IModelEventWatcher protocol

class assembl.models.notification.Notification(**kwargs)

Bases: sqlalchemy.ext.declarative.api.Base

A notification to a user about some situation.

first_matching_subscription_id

An annonymous pointer to the database object that originated the event

get_applicable_subscriptions()

Fist matching_subscription is guaranteed to always be on top

abstract get_notification_subject()

Typically for email

get_to_email_address()

Raises

UnverifiedEmailException: If the prefered email isn’t validated

render_to_email_html_part()

Override in child classes if your notification can be represented as email HTML part. Otherwise return a falsy string (len must be defined)

render_to_email_text_part()

Override in child classes if your notification can be represented as email HTML part. Otherwise return a falsy string (len must be defined)

class assembl.models.notification.NotificationCreationOrigin

Bases: assembl.lib.decl_enums.DeclEnum

class assembl.models.notification.NotificationDeliveryConfirmationType

Bases: assembl.lib.decl_enums.DeclEnum

The type of event that caused the notification to be created

class assembl.models.notification.NotificationDeliveryStateType

Bases: assembl.lib.decl_enums.DeclEnum

The delivery state of the notification. Essentially it’s licefycle

class assembl.models.notification.NotificationOnPost(**kwargs)

Bases: assembl.models.notification.Notification

first_matching_subscription_id

An annonymous pointer to the database object that originated the event

class assembl.models.notification.NotificationOnPostCreated(**kwargs)

Bases: assembl.models.notification.NotificationOnPost

first_matching_subscription_id

An annonymous pointer to the database object that originated the event

get_notification_subject()

Typically for email

render_to_email_html_part()

Override in child classes if your notification can be represented as email HTML part. Otherwise return a falsy string (len must be defined)

class assembl.models.notification.NotificationPushMethodType

Bases: assembl.lib.decl_enums.DeclEnum

The type of event that caused the notification to be created

class assembl.models.notification.NotificationSubscription(**kwargs)

Bases: assembl.models.DiscussionBoundBase, assembl.lib.history_mixin.OriginMixin

A subscription to a specific type of notification.

Subclasses will implement the actual code.

classmethod findApplicableInstances(discussion_id, verb, object, user=None)

Returns all subscriptions that would fire on the object, and verb given

This naive implementation instanciates every ACTIVE subscription for every user, and calls “would fire” for each. It is expected that most subclasses will override this with a more optimal implementation

classmethod get_discussion_conditions(discussion_id, alias_maker=None)

Returns a list of SQLA expressions that constrain a query on this class to a given discussion.

get_discussion_id()

Get the ID of an associated discussion object, if any.

get_human_readable_description()

A human readable description of this notification subscription Default implementation, expected to be overriden by child classes

is_owner(user_id)

The user owns this ressource, and has more permissions.

abstract process(discussion_id, verb, objectInstance, otherApplicableSubscriptions)

Process a CRUD event on a model, creating Notification as appropriate

classmethod restrict_to_owners_condition(query, user_id, alias=None, alias_maker=None)

Filter query according to object owners. Also allow to read subscriptions of templates.

unique_query()

returns a couple (query, usable), with a sqla query for conflicting similar objects. usable is true if the query has to be enforced; sometimes it makes sense to return un-usable query that will be used to construct queries of subclasses. Note that when a duplicate is found, you’ll often want to expunge the original.

user_can(user_id, operation, permissions)

Whether the user, with the given permissions, can perform the given Crud operation on this instance.

class assembl.models.notification.NotificationSubscriptionClasses

Bases: assembl.lib.decl_enums.DeclEnum

class assembl.models.notification.NotificationSubscriptionFollowAllMessages(**kwargs)

Bases: assembl.models.notification.NotificationSubscriptionGlobal

get_human_readable_description()

A human readable description of this notification subscription Default implementation, expected to be overriden by child classes

process(discussion_id, verb, objectInstance, otherApplicableSubscriptions)

Process a CRUD event on a model, creating Notification as appropriate

class assembl.models.notification.NotificationSubscriptionFollowOwnMessageDirectReplies(**kwargs)

Bases: assembl.models.notification.NotificationSubscriptionGlobal

get_human_readable_description()

A human readable description of this notification subscription Default implementation, expected to be overriden by child classes

process(discussion_id, verb, objectInstance, otherApplicableSubscriptions)

Process a CRUD event on a model, creating Notification as appropriate

class assembl.models.notification.NotificationSubscriptionFollowSyntheses(**kwargs)

Bases: assembl.models.notification.NotificationSubscriptionGlobal

get_human_readable_description()

A human readable description of this notification subscription Default implementation, expected to be overriden by child classes

process(discussion_id, verb, objectInstance, otherApplicableSubscriptions)

Process a CRUD event on a model, creating Notification as appropriate

class assembl.models.notification.NotificationSubscriptionGlobal(**kwargs)

Bases: assembl.models.notification.NotificationSubscription

unique_query()

returns a couple (query, usable), with a sqla query for conflicting similar objects. usable is true if the query has to be enforced; sometimes it makes sense to return un-usable query that will be used to construct queries of subclasses. Note that when a duplicate is found, you’ll often want to expunge the original.

class assembl.models.notification.NotificationSubscriptionOnExtract(**kwargs)

Bases: assembl.models.notification.NotificationSubscriptionOnObject

unique_query()

returns a couple (query, usable), with a sqla query for conflicting similar objects. usable is true if the query has to be enforced; sometimes it makes sense to return un-usable query that will be used to construct queries of subclasses. Note that when a duplicate is found, you’ll often want to expunge the original.

class assembl.models.notification.NotificationSubscriptionOnIdea(**kwargs)

Bases: assembl.models.notification.NotificationSubscriptionOnObject

unique_query()

returns a couple (query, usable), with a sqla query for conflicting similar objects. usable is true if the query has to be enforced; sometimes it makes sense to return un-usable query that will be used to construct queries of subclasses. Note that when a duplicate is found, you’ll often want to expunge the original.

class assembl.models.notification.NotificationSubscriptionOnObject(**kwargs)

Bases: assembl.models.notification.NotificationSubscription

class assembl.models.notification.NotificationSubscriptionOnPost(**kwargs)

Bases: assembl.models.notification.NotificationSubscriptionOnObject

unique_query()

returns a couple (query, usable), with a sqla query for conflicting similar objects. usable is true if the query has to be enforced; sometimes it makes sense to return un-usable query that will be used to construct queries of subclasses. Note that when a duplicate is found, you’ll often want to expunge the original.

class assembl.models.notification.NotificationSubscriptionOnUserAccount(**kwargs)

Bases: assembl.models.notification.NotificationSubscriptionOnObject

unique_query()

returns a couple (query, usable), with a sqla query for conflicting similar objects. usable is true if the query has to be enforced; sometimes it makes sense to return un-usable query that will be used to construct queries of subclasses. Note that when a duplicate is found, you’ll often want to expunge the original.

class assembl.models.notification.NotificationSubscriptionStatus

Bases: assembl.lib.decl_enums.DeclEnum

class assembl.models.notification.SafeMIMEText(text, subtype, charset)

Bases: email.mime.text.MIMEText

exception assembl.models.notification.UnverifiedEmailException

Bases: Exception