summaryrefslogtreecommitdiff
path: root/slixmpp/plugins/xep_0108/user_activity.py
blob: 4004ab8e22b2eda0fd35bef2b19a2b545ec6234b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
# Slixmpp: The Slick XMPP Library
# Copyright (C) 2011 Nathanael C. Fritz, Lance J.T. Stout
# This file is part of Slixmpp.
# See the file LICENSE for copying permission.

import logging

from asyncio import Future
from typing import Optional
from slixmpp.plugins.base import BasePlugin
from slixmpp.plugins.xep_0108 import stanza, UserActivity


log = logging.getLogger(__name__)


class XEP_0108(BasePlugin):

    """
    XEP-0108: User Activity
    """

    name = 'xep_0108'
    description = 'XEP-0108: User Activity'
    dependencies = {'xep_0163'}
    stanza = stanza

    def plugin_end(self):
        self.xmpp['xep_0030'].del_feature(feature=UserActivity.namespace)
        self.xmpp['xep_0163'].remove_interest(UserActivity.namespace)

    def session_bind(self, jid):
        self.xmpp['xep_0163'].register_pep('user_activity', UserActivity)

    def publish_activity(self, general: str, specific: Optional[str] = None,
                         text: Optional[str] = None, **pubsubkwargs) -> Future:
        """
        Publish the user's current activity.

        :param general: The required general category of the activity.
        :param specific: Optional specific activity being done as part
                         of the general category.
        :param text: Optional natural-language description or reason
                     for the activity.
        """
        activity = UserActivity()
        activity['value'] = (general, specific)
        activity['text'] = text
        return self.xmpp['xep_0163'].publish(
            activity,
            node=UserActivity.namespace,
            **pubsubkwargs
        )

    def stop(self, **pubsubkwargs) -> Future:
        """
        Clear existing user activity information to stop notifications.
        """
        activity = UserActivity()
        return self.xmpp['xep_0163'].publish(
            activity,
            node=UserActivity.namespace,
            **pubsubkwargs
        )