mirror of
https://github.com/zulip/zulip.git
synced 2025-10-27 10:03:56 +00:00
b2c29274f3
Before, presence information for an entire realm could only be queried via the `POST /api/v1/users/me/presence` endpoint. However, this endpoint also updates the presence information for the user making the request. Therefore, bot users are not allowed to access this endpoint because they don't have any presence data. This commit adds a new endpoint `GET /api/v1/realm/presence` that just returns the presence information for the realm of the caller. Fixes #10651.
85 lines
3.6 KiB
Python
85 lines
3.6 KiB
Python
|
|
import datetime
|
|
import time
|
|
|
|
from django.conf import settings
|
|
from typing import Any, Dict
|
|
|
|
from django.http import HttpRequest, HttpResponse
|
|
from django.utils.timezone import now as timezone_now
|
|
from django.utils.translation import ugettext as _
|
|
|
|
from zerver.decorator import human_users_only
|
|
from zerver.lib.actions import get_status_dict, update_user_presence
|
|
from zerver.lib.request import has_request_variables, REQ, JsonableError
|
|
from zerver.lib.response import json_success, json_error
|
|
from zerver.lib.timestamp import datetime_to_timestamp
|
|
from zerver.lib.validator import check_bool
|
|
from zerver.models import UserActivity, UserPresence, UserProfile, get_active_user
|
|
|
|
def get_status_list(requesting_user_profile: UserProfile) -> Dict[str, Any]:
|
|
return {'presences': get_status_dict(requesting_user_profile),
|
|
'server_timestamp': time.time()}
|
|
|
|
def get_presence_backend(request: HttpRequest, user_profile: UserProfile,
|
|
email: str) -> HttpResponse:
|
|
try:
|
|
target = get_active_user(email, user_profile.realm)
|
|
except UserProfile.DoesNotExist:
|
|
return json_error(_('No such user'))
|
|
if target.is_bot:
|
|
return json_error(_('Presence is not supported for bot users.'))
|
|
|
|
presence_dict = UserPresence.get_status_dict_by_user(target)
|
|
if len(presence_dict) == 0:
|
|
return json_error(_('No presence data for %s' % (target.email,)))
|
|
|
|
# For initial version, we just include the status and timestamp keys
|
|
result = dict(presence=presence_dict[target.email])
|
|
aggregated_info = result['presence']['aggregated']
|
|
aggr_status_duration = datetime_to_timestamp(timezone_now()) - aggregated_info['timestamp']
|
|
if aggr_status_duration > settings.OFFLINE_THRESHOLD_SECS:
|
|
aggregated_info['status'] = 'offline'
|
|
for val in result['presence'].values():
|
|
val.pop('client', None)
|
|
val.pop('pushable', None)
|
|
return json_success(result)
|
|
|
|
@human_users_only
|
|
@has_request_variables
|
|
def update_active_status_backend(request: HttpRequest, user_profile: UserProfile,
|
|
status: str=REQ(),
|
|
ping_only: bool=REQ(validator=check_bool, default=False),
|
|
new_user_input: bool=REQ(validator=check_bool, default=False)
|
|
) -> HttpResponse:
|
|
status_val = UserPresence.status_from_string(status)
|
|
if status_val is None:
|
|
raise JsonableError(_("Invalid status: %s") % (status,))
|
|
else:
|
|
update_user_presence(user_profile, request.client, timezone_now(),
|
|
status_val, new_user_input)
|
|
|
|
if ping_only:
|
|
ret = {} # type: Dict[str, Any]
|
|
else:
|
|
ret = get_status_list(user_profile)
|
|
|
|
if user_profile.realm.is_zephyr_mirror_realm:
|
|
# In zephyr mirroring realms, users can't see the presence of other
|
|
# users, but each user **is** interested in whether their mirror bot
|
|
# (running as their user) has been active.
|
|
try:
|
|
activity = UserActivity.objects.get(user_profile = user_profile,
|
|
query="get_events",
|
|
client__name="zephyr_mirror")
|
|
|
|
ret['zephyr_mirror_active'] = \
|
|
(activity.last_visit > timezone_now() - datetime.timedelta(minutes=5))
|
|
except UserActivity.DoesNotExist:
|
|
ret['zephyr_mirror_active'] = False
|
|
|
|
return json_success(ret)
|
|
|
|
def get_statuses_for_realm(request: HttpRequest, user_profile: UserProfile) -> HttpResponse:
|
|
return json_success(get_status_list(user_profile))
|