def fetch_message(self, request, facility, audience='any'):
"""
Fetch the first message available for the given ``facility`` and ``audience``, if it has
been persisted in the Redis datastore.
The current HTTP ``request`` is used to determine to whom the message belongs.
A unique string is used to identify the bucket's ``facility``.
Determines the ``audience`` to check for the message. Must be one of ``broadcast``,
``group``, ``user``, ``session`` or ``any``. The default is ``any``, which means to check
for all possible audiences.
"""
prefix = self.get_prefix()
channels = []
if audience in ('session', 'any',):
if request and request.session:
channels.append('{prefix}session:{0}:{facility}'.format(request.session.session_key, prefix=prefix, facility=facility))
if audience in ('user', 'any',):
if is_authenticated(request):
channels.append('{prefix}user:{0}:{facility}'.format(request.user.get_username(), prefix=prefix, facility=facility))
if audience in ('group', 'any',):
try:
if is_authenticated(request):
groups = request.session['ws4redis:memberof']
channels.extend('{prefix}group:{0}:{facility}'.format(g, prefix=prefix, facility=facility)
for g in groups)
except (KeyError, AttributeError):
pass
if audience in ('broadcast', 'any',):
channels.append('{prefix}broadcast:{facility}'.format(prefix=prefix, facility=facility))
for channel in channels:
message = self._connection.get(channel)
if message:
return message
def _get_message_channels(self, request=None, facility='{facility}', broadcast=False,
groups=(), users=(), sessions=()):
prefix = self.get_prefix()
channels = []
if broadcast is True:
# broadcast message to each subscriber listening on the named facility
channels.append('{prefix}broadcast:{facility}'.format(prefix=prefix, facility=facility))
# handle group messaging
if isinstance(groups, (list, tuple)):
# message is delivered to all listed groups
channels.extend('{prefix}group:{0}:{facility}'.format(g, prefix=prefix, facility=facility)
for g in _wrap_groups(groups, request))
elif groups is True and is_authenticated(request):
# message is delivered to all groups the currently logged in user belongs to
warnings.warn('Wrap groups=True into a list or tuple using SELF', DeprecationWarning)
channels.extend('{prefix}group:{0}:{facility}'.format(g, prefix=prefix, facility=facility)
for g in request.session.get('ws4redis:memberof', []))
elif isinstance(groups, basestring):
# message is delivered to the named group
warnings.warn('Wrap a single group into a list or tuple', DeprecationWarning)
channels.append('{prefix}group:{0}:{facility}'.format(groups, prefix=prefix, facility=facility))
elif not isinstance(groups, bool):
raise ValueError('Argument `groups` must be a list or tuple')
# handle user messaging
if isinstance(users, (list, tuple)):
# message is delivered to all listed users
channels.extend('{prefix}user:{0}:{facility}'.format(u, prefix=prefix, facility=facility)
for u in _wrap_users(users, request))
elif users is True and is_authenticated(request):
# message is delivered to browser instances of the currently logged in user
warnings.warn('Wrap users=True into a list or tuple using SELF', DeprecationWarning)
channels.append('{prefix}user:{0}:{facility}'.format(request.user.get_username(), prefix=prefix, facility=facility))
elif isinstance(users, basestring):
# message is delivered to the named user
warnings.warn('Wrap a single user into a list or tuple', DeprecationWarning)
channels.append('{prefix}user:{0}:{facility}'.format(users, prefix=prefix, facility=facility))
elif not isinstance(users, bool):
raise ValueError('Argument `users` must be a list or tuple')
# handle session messaging
if isinstance(sessions, (list, tuple)):
# message is delivered to all browsers instances listed in sessions
channels.extend('{prefix}session:{0}:{facility}'.format(s, prefix=prefix, facility=facility)
for s in _wrap_sessions(sessions, request))
elif sessions is True and request and request.session:
# message is delivered to browser instances owning the current session
warnings.warn('Wrap a single session key into a list or tuple using SELF', DeprecationWarning)
channels.append('{prefix}session:{0}:{facility}'.format(request.session.session_key, prefix=prefix, facility=facility))
elif isinstance(sessions, basestring):
# message is delivered to the named user
warnings.warn('Wrap a single session key into a list or tuple', DeprecationWarning)
channels.append('{prefix}session:{0}:{facility}'.format(sessions, prefix=prefix, facility=facility))
elif not isinstance(sessions, bool):
raise ValueError('Argument `sessions` must be a list or tuple')
return channels
def fetch_message(self, request, facility, audience='any'):
"""
Fetch the first message available for the given ``facility`` and ``audience``, if it has
been persisted in the Redis datastore.
The current HTTP ``request`` is used to determine to whom the message belongs.
A unique string is used to identify the bucket's ``facility``.
Determines the ``audience`` to check for the message. Must be one of ``broadcast``,
``group``, ``user``, ``session`` or ``any``. The default is ``any``, which means to check
for all possible audiences.
"""
prefix = self.get_prefix()
channels = []
if audience in (
'session',
'any',
):
if request and request.session:
channels.append('{prefix}session:{0}:{facility}'.format(
request.session.session_key,
prefix=prefix,
facility=facility))
if audience in (
'user',
'any',
):
if is_authenticated(request):
channels.append('{prefix}user:{0}:{facility}'.format(
request.user.get_username(),
prefix=prefix,
facility=facility))
if audience in (
'group',
'any',
):
try:
if is_authenticated(request):
groups = request.session['ws4redis:memberof']
channels.extend('{prefix}group:{0}:{facility}'.format(
g, prefix=prefix, facility=facility) for g in groups)
except (KeyError, AttributeError):
pass
if audience in (
'broadcast',
'any',
):
channels.append('{prefix}broadcast:{facility}'.format(
prefix=prefix, facility=facility))
for channel in channels:
message = self._connection.get(channel)
if message:
return message
def _wrap_users(users, request):
"""
Returns a list with the given list of users and/or the currently logged in user, if the list
contains the magic item SELF.
"""
result = set()
for u in users:
if u is SELF and is_authenticated(request):
result.add(request.user.get_username())
else:
result.add(u)
return result
def _wrap_users(users, request):
"""
Returns a list with the given list of users and/or the currently logged in user, if the list
contains the magic item SELF.
"""
result = set()
for u in users:
if u is SELF and is_authenticated(request):
result.add(request.user.get_username())
else:
result.add(u)
return result
def _wrap_groups(groups, request):
"""
Returns a list of groups for the given list of groups and/or the current logged in user, if
the list contains the magic item SELF.
Note that this method bypasses Django's own group resolution, which requires a database query
and thus is unsuitable for coroutines.
Therefore the membership is takes from the session store, which is filled by a signal handler,
while the users logs in.
"""
result = set()
for g in groups:
if g is SELF and is_authenticated(request):
result.update(request.session.get('ws4redis:memberof', []))
else:
result.add(g)
return result
def _wrap_groups(groups, request):
"""
Returns a list of groups for the given list of groups and/or the current logged in user, if
the list contains the magic item SELF.
Note that this method bypasses Django's own group resolution, which requires a database query
and thus is unsuitable for coroutines.
Therefore the membership is takes from the session store, which is filled by a signal handler,
while the users logs in.
"""
result = set()
for g in groups:
if g is SELF and is_authenticated(request):
result.update(request.session.get('ws4redis:memberof', []))
else:
result.add(g)
return result
def _get_message_channels(self,
request=None,
facility='{facility}',
broadcast=False,
groups=(),
users=(),
sessions=()):
prefix = self.get_prefix()
channels = []
if broadcast is True:
# broadcast message to each subscriber listening on the named facility
channels.append('{prefix}broadcast:{facility}'.format(
prefix=prefix, facility=facility))
# handle group messaging
if isinstance(groups, (list, tuple)):
# message is delivered to all listed groups
channels.extend('{prefix}group:{0}:{facility}'.format(
g, prefix=prefix, facility=facility)
for g in _wrap_groups(groups, request))
elif groups is True and is_authenticated(request):
# message is delivered to all groups the currently logged in user belongs to
warnings.warn('Wrap groups=True into a list or tuple using SELF',
DeprecationWarning)
channels.extend(
'{prefix}group:{0}:{facility}'.format(
g, prefix=prefix, facility=facility)
for g in request.session.get('ws4redis:memberof', []))
elif isinstance(groups, basestring):
# message is delivered to the named group
warnings.warn('Wrap a single group into a list or tuple',
DeprecationWarning)
channels.append('{prefix}group:{0}:{facility}'.format(
groups, prefix=prefix, facility=facility))
elif not isinstance(groups, bool):
raise ValueError('Argument `groups` must be a list or tuple')
# handle user messaging
if isinstance(users, (list, tuple)):
# message is delivered to all listed users
channels.extend('{prefix}user:{0}:{facility}'.format(
u, prefix=prefix, facility=facility)
for u in _wrap_users(users, request))
elif users is True and is_authenticated(request):
# message is delivered to browser instances of the currently logged in user
warnings.warn('Wrap users=True into a list or tuple using SELF',
DeprecationWarning)
channels.append('{prefix}user:{0}:{facility}'.format(
request.user.get_username(), prefix=prefix, facility=facility))
elif isinstance(users, basestring):
# message is delivered to the named user
warnings.warn('Wrap a single user into a list or tuple',
DeprecationWarning)
channels.append('{prefix}user:{0}:{facility}'.format(
users, prefix=prefix, facility=facility))
elif not isinstance(users, bool):
raise ValueError('Argument `users` must be a list or tuple')
# handle session messaging
if isinstance(sessions, (list, tuple)):
# message is delivered to all browsers instances listed in sessions
channels.extend('{prefix}session:{0}:{facility}'.format(
s, prefix=prefix, facility=facility)
for s in _wrap_sessions(sessions, request))
elif sessions is True and request and request.session:
# message is delivered to browser instances owning the current session
warnings.warn(
'Wrap a single session key into a list or tuple using SELF',
DeprecationWarning)
channels.append('{prefix}session:{0}:{facility}'.format(
request.session.session_key, prefix=prefix, facility=facility))
elif isinstance(sessions, basestring):
# message is delivered to the named user
warnings.warn('Wrap a single session key into a list or tuple',
DeprecationWarning)
channels.append('{prefix}session:{0}:{facility}'.format(
sessions, prefix=prefix, facility=facility))
elif not isinstance(sessions, bool):
raise ValueError('Argument `sessions` must be a list or tuple')
return channels
