2020-06-11 00:54:34 +02:00
|
|
|
import os
|
2021-08-15 18:32:51 +02:00
|
|
|
from typing import List, Union
|
2020-06-11 00:54:34 +02:00
|
|
|
|
2012-08-28 21:31:32 +02:00
|
|
|
from django.conf import settings
|
2020-05-05 15:44:24 +02:00
|
|
|
from django.conf.urls import include
|
2016-05-19 17:33:30 +02:00
|
|
|
from django.conf.urls.i18n import i18n_patterns
|
2020-06-11 00:54:34 +02:00
|
|
|
from django.contrib.auth.views import (
|
|
|
|
|
LoginView,
|
|
|
|
|
PasswordResetCompleteView,
|
|
|
|
|
PasswordResetConfirmView,
|
|
|
|
|
PasswordResetDoneView,
|
|
|
|
|
)
|
2021-09-10 18:36:56 +02:00
|
|
|
from django.urls import path, re_path
|
2021-08-15 18:32:51 +02:00
|
|
|
from django.urls.resolvers import URLPattern, URLResolver
|
2016-05-19 17:33:30 +02:00
|
|
|
from django.utils.module_loading import import_string
|
2023-01-20 08:22:48 +01:00
|
|
|
from django.views.generic import RedirectView
|
2016-10-27 14:52:56 +02:00
|
|
|
|
2020-09-22 05:31:38 +02:00
|
|
|
from zerver.forms import LoggingSetPasswordForm
|
2020-06-11 00:54:34 +02:00
|
|
|
from zerver.lib.integrations import WEBHOOK_INTEGRATIONS
|
2020-09-22 06:04:45 +02:00
|
|
|
from zerver.lib.rest import rest_path
|
2022-07-08 20:20:17 +02:00
|
|
|
from zerver.lib.url_redirects import DOCUMENTATION_REDIRECTS
|
2020-09-22 05:31:38 +02:00
|
|
|
from zerver.tornado.views import cleanup_event_queue, get_events, get_events_internal, notify
|
|
|
|
|
from zerver.views.alert_words import add_alert_words, list_alert_words, remove_alert_words
|
|
|
|
|
from zerver.views.attachments import list_by_user, remove
|
|
|
|
|
from zerver.views.auth import (
|
|
|
|
|
api_fetch_api_key,
|
|
|
|
|
api_get_server_settings,
|
|
|
|
|
json_fetch_api_key,
|
2022-09-13 17:39:18 +02:00
|
|
|
jwt_fetch_api_key,
|
2020-09-22 05:31:38 +02:00
|
|
|
log_into_subdomain,
|
|
|
|
|
login_page,
|
|
|
|
|
logout_then_login,
|
|
|
|
|
password_reset,
|
|
|
|
|
remote_user_jwt,
|
|
|
|
|
remote_user_sso,
|
|
|
|
|
saml_sp_metadata,
|
|
|
|
|
show_deactivation_notice,
|
|
|
|
|
start_remote_user_sso,
|
|
|
|
|
start_social_login,
|
|
|
|
|
start_social_signup,
|
|
|
|
|
)
|
|
|
|
|
from zerver.views.compatibility import check_global_compatibility
|
|
|
|
|
from zerver.views.custom_profile_fields import (
|
|
|
|
|
create_realm_custom_profile_field,
|
|
|
|
|
delete_realm_custom_profile_field,
|
|
|
|
|
list_realm_custom_profile_fields,
|
|
|
|
|
remove_user_custom_profile_data,
|
|
|
|
|
reorder_realm_custom_profile_fields,
|
|
|
|
|
update_realm_custom_profile_field,
|
|
|
|
|
update_user_custom_profile_data,
|
|
|
|
|
)
|
|
|
|
|
from zerver.views.digest import digest_page
|
|
|
|
|
from zerver.views.documentation import IntegrationView, MarkdownDirectoryView, integration_doc
|
|
|
|
|
from zerver.views.drafts import create_drafts, delete_draft, edit_draft, fetch_drafts
|
|
|
|
|
from zerver.views.email_mirror import email_mirror_message
|
|
|
|
|
from zerver.views.events_register import events_register_backend
|
|
|
|
|
from zerver.views.home import accounts_accept_terms, desktop_home, home
|
|
|
|
|
from zerver.views.hotspots import mark_hotspot_as_read
|
|
|
|
|
from zerver.views.invite import (
|
|
|
|
|
generate_multiuse_invite_backend,
|
|
|
|
|
get_user_invites,
|
|
|
|
|
invite_users_backend,
|
|
|
|
|
resend_user_invite_email,
|
|
|
|
|
revoke_multiuse_invite,
|
|
|
|
|
revoke_user_invite,
|
|
|
|
|
)
|
|
|
|
|
from zerver.views.message_edit import (
|
|
|
|
|
delete_message_backend,
|
|
|
|
|
get_message_edit_history,
|
|
|
|
|
json_fetch_raw_message,
|
|
|
|
|
update_message_backend,
|
|
|
|
|
)
|
|
|
|
|
from zerver.views.message_fetch import get_messages_backend, messages_in_narrow_backend
|
|
|
|
|
from zerver.views.message_flags import (
|
|
|
|
|
mark_all_as_read,
|
|
|
|
|
mark_stream_as_read,
|
|
|
|
|
mark_topic_as_read,
|
|
|
|
|
update_message_flags,
|
2022-11-10 01:06:37 +01:00
|
|
|
update_message_flags_for_narrow,
|
2020-09-22 05:31:38 +02:00
|
|
|
)
|
|
|
|
|
from zerver.views.message_send import render_message_backend, send_message_backend, zcommand_backend
|
2023-02-10 14:33:24 +01:00
|
|
|
from zerver.views.muted_users import mute_user, unmute_user
|
2020-09-22 05:31:38 +02:00
|
|
|
from zerver.views.presence import (
|
|
|
|
|
get_presence_backend,
|
|
|
|
|
get_statuses_for_realm,
|
|
|
|
|
update_active_status_backend,
|
|
|
|
|
update_user_status_backend,
|
|
|
|
|
)
|
|
|
|
|
from zerver.views.push_notifications import (
|
|
|
|
|
add_android_reg_id,
|
|
|
|
|
add_apns_device_token,
|
|
|
|
|
remove_android_reg_id,
|
|
|
|
|
remove_apns_device_token,
|
|
|
|
|
)
|
|
|
|
|
from zerver.views.reactions import add_reaction, remove_reaction
|
2021-06-16 21:15:47 +02:00
|
|
|
from zerver.views.read_receipts import read_receipts
|
2020-09-22 05:31:38 +02:00
|
|
|
from zerver.views.realm import (
|
|
|
|
|
check_subdomain_available,
|
|
|
|
|
deactivate_realm,
|
|
|
|
|
realm_reactivation,
|
|
|
|
|
update_realm,
|
2021-07-21 13:23:23 +02:00
|
|
|
update_realm_user_settings_defaults,
|
2020-09-22 05:31:38 +02:00
|
|
|
)
|
|
|
|
|
from zerver.views.realm_domains import (
|
|
|
|
|
create_realm_domain,
|
|
|
|
|
delete_realm_domain,
|
|
|
|
|
list_realm_domains,
|
|
|
|
|
patch_realm_domain,
|
|
|
|
|
)
|
|
|
|
|
from zerver.views.realm_emoji import delete_emoji, list_emoji, upload_emoji
|
|
|
|
|
from zerver.views.realm_export import delete_realm_export, export_realm, get_realm_exports
|
|
|
|
|
from zerver.views.realm_icon import delete_icon_backend, get_icon_backend, upload_icon
|
2021-04-15 19:51:36 +02:00
|
|
|
from zerver.views.realm_linkifiers import (
|
|
|
|
|
create_linkifier,
|
|
|
|
|
delete_linkifier,
|
|
|
|
|
list_linkifiers,
|
|
|
|
|
update_linkifier,
|
|
|
|
|
)
|
2020-09-22 05:31:38 +02:00
|
|
|
from zerver.views.realm_logo import delete_logo_backend, get_logo_backend, upload_logo
|
2020-10-27 02:21:22 +01:00
|
|
|
from zerver.views.realm_playgrounds import add_realm_playground, delete_realm_playground
|
2020-09-22 05:31:38 +02:00
|
|
|
from zerver.views.registration import (
|
|
|
|
|
accounts_home,
|
|
|
|
|
accounts_home_from_multiuse_invite,
|
|
|
|
|
accounts_register,
|
|
|
|
|
create_realm,
|
|
|
|
|
find_account,
|
2021-11-29 16:20:59 +01:00
|
|
|
get_prereg_key_and_redirect,
|
2022-12-08 11:08:55 +01:00
|
|
|
new_realm_send_confirm,
|
2020-09-22 05:31:38 +02:00
|
|
|
realm_redirect,
|
2023-02-24 09:08:26 +01:00
|
|
|
realm_register,
|
2023-01-20 08:22:48 +01:00
|
|
|
signup_send_confirm,
|
2020-09-22 05:31:38 +02:00
|
|
|
)
|
|
|
|
|
from zerver.views.report import (
|
|
|
|
|
report_csp_violations,
|
|
|
|
|
report_narrow_times,
|
|
|
|
|
report_send_times,
|
|
|
|
|
report_unnarrow_times,
|
|
|
|
|
)
|
2023-04-20 04:26:41 +02:00
|
|
|
from zerver.views.scheduled_messages import (
|
|
|
|
|
delete_scheduled_messages,
|
|
|
|
|
fetch_scheduled_messages,
|
|
|
|
|
scheduled_messages_backend,
|
|
|
|
|
)
|
2023-03-24 16:00:46 +01:00
|
|
|
from zerver.views.sentry import sentry_tunnel
|
2020-09-22 05:31:38 +02:00
|
|
|
from zerver.views.storage import get_storage, remove_storage, update_storage
|
|
|
|
|
from zerver.views.streams import (
|
|
|
|
|
add_default_stream,
|
|
|
|
|
add_subscriptions_backend,
|
|
|
|
|
create_default_stream_group,
|
|
|
|
|
deactivate_stream_backend,
|
|
|
|
|
delete_in_topic,
|
2022-05-18 13:54:35 +02:00
|
|
|
get_stream_backend,
|
2020-09-22 05:31:38 +02:00
|
|
|
get_streams_backend,
|
|
|
|
|
get_subscribers_backend,
|
|
|
|
|
get_topics_backend,
|
|
|
|
|
json_get_stream_id,
|
|
|
|
|
list_subscriptions_backend,
|
|
|
|
|
remove_default_stream,
|
|
|
|
|
remove_default_stream_group,
|
|
|
|
|
remove_subscriptions_backend,
|
|
|
|
|
update_default_stream_group_info,
|
|
|
|
|
update_default_stream_group_streams,
|
|
|
|
|
update_stream_backend,
|
|
|
|
|
update_subscription_properties_backend,
|
|
|
|
|
update_subscriptions_backend,
|
|
|
|
|
update_subscriptions_property,
|
|
|
|
|
)
|
|
|
|
|
from zerver.views.submessage import process_submessage
|
|
|
|
|
from zerver.views.thumbnail import backend_serve_thumbnail
|
|
|
|
|
from zerver.views.tutorial import set_tutorial_status
|
|
|
|
|
from zerver.views.typing import send_notification_backend
|
|
|
|
|
from zerver.views.unsubscribe import email_unsubscribe
|
|
|
|
|
from zerver.views.upload import (
|
|
|
|
|
serve_file_backend,
|
2022-03-22 04:38:18 +01:00
|
|
|
serve_file_download_backend,
|
uploads: Serve S3 uploads directly from nginx.
When file uploads are stored in S3, this means that Zulip serves as a
302 to S3. Because browsers do not cache redirects, this means that
no image contents can be cached -- and upon every page load or reload,
every recently-posted image must be re-fetched. This incurs extra
load on the Zulip server, as well as potentially excessive bandwidth
usage from S3, and on the client's connection.
Switch to fetching the content from S3 in nginx, and serving the
content from nginx. These have `Cache-control: private, immutable`
headers set on the response, allowing browsers to cache them locally.
Because nginx fetching from S3 can be slow, and requests for uploads
will generally be bunched around when a message containing them are
first posted, we instruct nginx to cache the contents locally. This
is safe because uploaded file contents are immutable; access control
is still mediated by Django. The nginx cache key is the URL without
query parameters, as those parameters include a time-limited signed
authentication parameter which lets nginx fetch the non-public file.
This adds a number of nginx-level configuration parameters to control
the caching which nginx performs, including the amount of in-memory
index for he cache, the maximum storage of the cache on disk, and how
long data is retained in the cache. The currently-chosen figures are
reasonable for small to medium deployments.
The most notable effect of this change is in allowing browsers to
cache uploaded image content; however, while there will be many fewer
requests, it also has an improvement on request latency. The
following tests were done with a non-AWS client in SFO, a server and
S3 storage in us-east-1, and with 100 requests after 10 requests of
warm-up (to fill the nginx cache). The mean and standard deviation
are shown.
| | Redirect to S3 | Caching proxy, hot | Caching proxy, cold |
| ----------------- | ------------------- | ------------------- | ------------------- |
| Time in Django | 263.0 ms ± 28.3 ms | 258.0 ms ± 12.3 ms | 258.0 ms ± 12.3 ms |
| Small file (842b) | 586.1 ms ± 21.1 ms | 266.1 ms ± 67.4 ms | 288.6 ms ± 17.7 ms |
| Large file (660k) | 959.6 ms ± 137.9 ms | 609.5 ms ± 13.0 ms | 648.1 ms ± 43.2 ms |
The hot-cache performance is faster for both large and small files,
since it saves the client the time having to make a second request to
a separate host. This performance improvement remains at least 100ms
even if the client is on the same coast as the server.
Cold nginx caches are only slightly slower than hot caches, because
VPC access to S3 endpoints is extremely fast (assuming it is in the
same region as the host), and nginx can pool connections to S3 and
reuse them.
However, all of the 648ms taken to serve a cold-cache large file is
occupied in nginx, as opposed to the only 263ms which was spent in
nginx when using redirects to S3. This means that to overall spend
less time responding to uploaded-file requests in nginx, clients will
need to find files in their local cache, and skip making an
uploaded-file request, at least 60% of the time. Modeling shows a
reduction in the number of client requests by about 70% - 80%.
The `Content-Disposition` header logic can now also be entirely shared
with the local-file codepath, as can the `url_only` path used by
mobile clients. While we could provide the direct-to-S3 temporary
signed URL to mobile clients, we choose to provide the
served-from-Zulip signed URL, to better control caching headers on it,
and greater consistency. In doing so, we adjust the salt used for the
URL; since these URLs are only valid for 60s, the effect of this salt
change is minimal.
2022-11-22 20:41:35 +01:00
|
|
|
serve_file_unauthed_from_token,
|
2020-09-22 05:31:38 +02:00
|
|
|
serve_file_url_backend,
|
2022-12-06 22:24:43 +01:00
|
|
|
serve_local_avatar_unauthed,
|
2020-09-22 05:31:38 +02:00
|
|
|
upload_file_backend,
|
|
|
|
|
)
|
|
|
|
|
from zerver.views.user_groups import (
|
|
|
|
|
add_user_group,
|
|
|
|
|
delete_user_group,
|
|
|
|
|
edit_user_group,
|
2022-03-18 14:38:11 +01:00
|
|
|
get_is_user_group_member,
|
2022-04-04 13:59:25 +02:00
|
|
|
get_subgroups_of_user_group,
|
2020-09-22 05:31:38 +02:00
|
|
|
get_user_group,
|
2022-03-24 11:39:57 +01:00
|
|
|
get_user_group_members,
|
2022-03-02 11:58:37 +01:00
|
|
|
update_subgroups_of_user_group,
|
2020-09-22 05:31:38 +02:00
|
|
|
update_user_group_backend,
|
|
|
|
|
)
|
|
|
|
|
from zerver.views.user_settings import (
|
|
|
|
|
confirm_email_change,
|
|
|
|
|
delete_avatar_backend,
|
|
|
|
|
json_change_settings,
|
|
|
|
|
regenerate_api_key,
|
|
|
|
|
set_avatar_backend,
|
|
|
|
|
)
|
2023-03-31 21:18:12 +02:00
|
|
|
from zerver.views.user_topics import update_muted_topic, update_user_topic
|
2020-09-22 05:31:38 +02:00
|
|
|
from zerver.views.users import (
|
|
|
|
|
add_bot_backend,
|
|
|
|
|
avatar,
|
2022-08-15 21:50:30 +02:00
|
|
|
avatar_medium,
|
2020-09-22 05:31:38 +02:00
|
|
|
create_user_backend,
|
|
|
|
|
deactivate_bot_backend,
|
|
|
|
|
deactivate_user_backend,
|
|
|
|
|
deactivate_user_own_backend,
|
|
|
|
|
get_bots_backend,
|
|
|
|
|
get_members_backend,
|
|
|
|
|
get_profile_backend,
|
|
|
|
|
get_subscription_backend,
|
2021-01-02 15:05:29 +01:00
|
|
|
get_user_by_email,
|
2020-09-22 05:31:38 +02:00
|
|
|
patch_bot_backend,
|
|
|
|
|
reactivate_user_backend,
|
|
|
|
|
regenerate_bot_api_key,
|
|
|
|
|
update_user_backend,
|
|
|
|
|
)
|
|
|
|
|
from zerver.views.video_calls import (
|
|
|
|
|
complete_zoom_user,
|
|
|
|
|
deauthorize_zoom_user,
|
|
|
|
|
get_bigbluebutton_url,
|
|
|
|
|
join_bigbluebutton,
|
|
|
|
|
make_zoom_video_call,
|
|
|
|
|
register_zoom_user,
|
|
|
|
|
)
|
|
|
|
|
from zerver.views.zephyr import webathena_kerberos_login
|
2020-06-11 00:54:34 +02:00
|
|
|
from zproject import dev_urls
|
|
|
|
|
from zproject.legacy_urls import legacy_urls
|
2016-10-27 14:52:56 +02:00
|
|
|
|
2017-07-12 09:36:51 +02:00
|
|
|
if settings.TWO_FACTOR_AUTHENTICATION_ENABLED:
|
|
|
|
|
from two_factor.gateways.twilio.urls import urlpatterns as tf_twilio_urls
|
2020-06-11 00:54:34 +02:00
|
|
|
from two_factor.urls import urlpatterns as tf_urls
|
2017-07-12 09:36:51 +02:00
|
|
|
|
2013-03-21 22:38:02 +01:00
|
|
|
# NB: There are several other pieces of code which route requests by URL:
|
|
|
|
|
#
|
2016-06-24 01:20:37 +02:00
|
|
|
# - legacy_urls.py contains API endpoint written before the redesign
|
|
|
|
|
# and should not be added to.
|
|
|
|
|
#
|
2013-03-21 22:38:02 +01:00
|
|
|
# - runtornado.py has its own URL list for Tornado views. See the
|
|
|
|
|
# invocation of web.Application in that file.
|
|
|
|
|
#
|
2022-01-25 07:21:47 +01:00
|
|
|
# - The nginx config knows which URLs to route to Django or Tornado.
|
2013-03-21 22:38:02 +01:00
|
|
|
#
|
2023-03-04 02:17:54 +01:00
|
|
|
# - Likewise for the local dev server in tools/run-dev.
|
2013-03-21 22:38:02 +01:00
|
|
|
|
2017-10-18 07:09:22 +02:00
|
|
|
# These endpoints constitute the currently designed API (V1), which uses:
|
2016-06-25 00:36:28 +02:00
|
|
|
# * REST verbs
|
|
|
|
|
# * Basic auth (username:password is email:apiKey)
|
|
|
|
|
# * Take and return json-formatted data
|
2016-06-24 01:20:37 +02:00
|
|
|
#
|
|
|
|
|
# If you're adding a new endpoint to the code that requires authentication,
|
|
|
|
|
# please add it here.
|
|
|
|
|
# See rest_dispatch in zerver.lib.rest for an explanation of auth methods used
|
|
|
|
|
#
|
2017-10-18 07:09:22 +02:00
|
|
|
# All of these paths are accessed by either a /json or /api/v1 prefix;
|
|
|
|
|
# e.g. `PATCH /json/realm` or `PATCH /api/v1/realm`.
|
2016-06-24 02:26:09 +02:00
|
|
|
v1_api_and_json_patterns = [
|
2016-06-25 00:54:47 +02:00
|
|
|
# realm-level calls
|
2021-02-12 08:20:45 +01:00
|
|
|
rest_path("realm", PATCH=update_realm),
|
2021-07-21 13:23:23 +02:00
|
|
|
rest_path("realm/user_settings_defaults", PATCH=update_realm_user_settings_defaults),
|
2021-02-12 08:20:45 +01:00
|
|
|
path("realm/subdomain/<subdomain>", check_subdomain_available),
|
2017-03-31 21:14:11 +02:00
|
|
|
# realm/domains -> zerver.views.realm_domains
|
2021-02-12 08:20:45 +01:00
|
|
|
rest_path("realm/domains", GET=list_realm_domains, POST=create_realm_domain),
|
|
|
|
|
rest_path("realm/domains/<domain>", PATCH=patch_realm_domain, DELETE=delete_realm_domain),
|
2016-06-25 00:54:47 +02:00
|
|
|
# realm/emoji -> zerver.views.realm_emoji
|
2021-02-12 08:20:45 +01:00
|
|
|
rest_path("realm/emoji", GET=list_emoji),
|
2021-02-12 08:19:30 +01:00
|
|
|
rest_path(
|
2022-07-14 08:42:05 +02:00
|
|
|
"realm/emoji/<path:emoji_name>",
|
2021-02-12 08:19:30 +01:00
|
|
|
POST=upload_emoji,
|
|
|
|
|
DELETE=(delete_emoji, {"intentionally_undocumented"}),
|
|
|
|
|
),
|
2019-07-04 18:12:53 +02:00
|
|
|
# this endpoint throws a status code 400 JsonableError when it should be a 404.
|
2017-02-21 03:41:20 +01:00
|
|
|
# realm/icon -> zerver.views.realm_icon
|
2021-02-12 08:20:45 +01:00
|
|
|
rest_path("realm/icon", POST=upload_icon, DELETE=delete_icon_backend, GET=get_icon_backend),
|
2019-01-27 08:25:10 +01:00
|
|
|
# realm/logo -> zerver.views.realm_logo
|
2021-02-12 08:20:45 +01:00
|
|
|
rest_path("realm/logo", POST=upload_logo, DELETE=delete_logo_backend, GET=get_logo_backend),
|
2021-03-30 12:51:54 +02:00
|
|
|
# realm/filters and realm/linkifiers -> zerver.views.realm_linkifiers
|
|
|
|
|
rest_path("realm/linkifiers", GET=list_linkifiers),
|
|
|
|
|
rest_path("realm/filters", POST=create_linkifier),
|
2021-04-15 19:51:36 +02:00
|
|
|
rest_path("realm/filters/<int:filter_id>", DELETE=delete_linkifier, PATCH=update_linkifier),
|
2020-10-27 02:14:56 +01:00
|
|
|
# realm/playgrounds -> zerver.views.realm_playgrounds
|
|
|
|
|
rest_path("realm/playgrounds", POST=add_realm_playground),
|
2020-10-27 02:21:22 +01:00
|
|
|
rest_path("realm/playgrounds/<int:playground_id>", DELETE=delete_realm_playground),
|
2017-03-17 10:07:22 +01:00
|
|
|
# realm/profile_fields -> zerver.views.custom_profile_fields
|
2021-02-12 08:19:30 +01:00
|
|
|
rest_path(
|
2021-02-12 08:20:45 +01:00
|
|
|
"realm/profile_fields",
|
2021-02-12 08:19:30 +01:00
|
|
|
GET=list_realm_custom_profile_fields,
|
|
|
|
|
PATCH=reorder_realm_custom_profile_fields,
|
|
|
|
|
POST=create_realm_custom_profile_field,
|
|
|
|
|
),
|
|
|
|
|
rest_path(
|
2021-02-12 08:20:45 +01:00
|
|
|
"realm/profile_fields/<int:field_id>",
|
2021-02-12 08:19:30 +01:00
|
|
|
PATCH=update_realm_custom_profile_field,
|
|
|
|
|
DELETE=delete_realm_custom_profile_field,
|
|
|
|
|
),
|
2018-01-30 14:58:50 +01:00
|
|
|
# realm/deactivate -> zerver.views.deactivate_realm
|
2021-02-12 08:20:45 +01:00
|
|
|
rest_path("realm/deactivate", POST=deactivate_realm),
|
2016-06-25 00:54:47 +02:00
|
|
|
# users -> zerver.views.users
|
2021-02-12 08:20:45 +01:00
|
|
|
rest_path("users", GET=get_members_backend, POST=create_user_backend),
|
|
|
|
|
rest_path("users/me", GET=get_profile_backend, DELETE=deactivate_user_own_backend),
|
|
|
|
|
rest_path("users/<int:user_id>/reactivate", POST=reactivate_user_backend),
|
2021-02-12 08:19:30 +01:00
|
|
|
rest_path(
|
2021-02-12 08:20:45 +01:00
|
|
|
"users/<int:user_id>",
|
2021-02-12 08:19:30 +01:00
|
|
|
GET=get_members_backend,
|
|
|
|
|
PATCH=update_user_backend,
|
|
|
|
|
DELETE=deactivate_user_backend,
|
|
|
|
|
),
|
2021-02-12 08:20:45 +01:00
|
|
|
rest_path("users/<int:user_id>/subscriptions/<int:stream_id>", GET=get_subscription_backend),
|
2021-01-02 15:05:29 +01:00
|
|
|
rest_path("users/<email>", GET=get_user_by_email),
|
2021-02-12 08:20:45 +01:00
|
|
|
rest_path("bots", GET=get_bots_backend, POST=add_bot_backend),
|
|
|
|
|
rest_path("bots/<int:bot_id>/api_key/regenerate", POST=regenerate_bot_api_key),
|
|
|
|
|
rest_path("bots/<int:bot_id>", PATCH=patch_bot_backend, DELETE=deactivate_bot_backend),
|
2017-07-31 20:55:57 +02:00
|
|
|
# invites -> zerver.views.invite
|
2021-02-12 08:20:45 +01:00
|
|
|
rest_path("invites", GET=get_user_invites, POST=invite_users_backend),
|
|
|
|
|
rest_path("invites/<int:prereg_id>", DELETE=revoke_user_invite),
|
|
|
|
|
rest_path("invites/<int:prereg_id>/resend", POST=resend_user_invite_email),
|
2018-03-02 12:27:57 +01:00
|
|
|
# invites/multiuse -> zerver.views.invite
|
2021-02-12 08:20:45 +01:00
|
|
|
rest_path("invites/multiuse", POST=generate_multiuse_invite_backend),
|
2019-02-15 19:09:25 +01:00
|
|
|
# invites/multiuse -> zerver.views.invite
|
2021-02-12 08:20:45 +01:00
|
|
|
rest_path("invites/multiuse/<int:invite_id>", DELETE=revoke_multiuse_invite),
|
2017-08-04 20:26:38 +02:00
|
|
|
# mark messages as read (in bulk)
|
2021-02-12 08:20:45 +01:00
|
|
|
rest_path("mark_all_as_read", POST=mark_all_as_read),
|
|
|
|
|
rest_path("mark_stream_as_read", POST=mark_stream_as_read),
|
|
|
|
|
rest_path("mark_topic_as_read", POST=mark_topic_as_read),
|
|
|
|
|
rest_path("zcommand", POST=zcommand_backend),
|
2020-07-21 18:04:50 +02:00
|
|
|
# Endpoints for syncing drafts.
|
2021-02-14 12:56:14 +01:00
|
|
|
rest_path("drafts", GET=fetch_drafts, POST=create_drafts),
|
|
|
|
|
rest_path("drafts/<int:draft_id>", PATCH=edit_draft, DELETE=delete_draft),
|
2023-04-14 21:19:46 +02:00
|
|
|
# New scheduled messages are created via send_message_backend.
|
2023-04-20 04:26:41 +02:00
|
|
|
rest_path("scheduled_messages", GET=fetch_scheduled_messages, POST=scheduled_messages_backend),
|
2023-04-14 21:19:46 +02:00
|
|
|
rest_path("scheduled_messages/<int:scheduled_message_id>", DELETE=delete_scheduled_messages),
|
2020-06-22 22:57:01 +02:00
|
|
|
# messages -> zerver.views.message*
|
2013-12-12 18:36:32 +01:00
|
|
|
# GET returns messages, possibly filtered, POST sends a message
|
2021-02-12 08:19:30 +01:00
|
|
|
rest_path(
|
2021-02-12 08:20:45 +01:00
|
|
|
"messages",
|
|
|
|
|
GET=(get_messages_backend, {"allow_anonymous_user_web"}),
|
|
|
|
|
POST=(send_message_backend, {"allow_incoming_webhooks"}),
|
2021-02-12 08:19:30 +01:00
|
|
|
),
|
|
|
|
|
rest_path(
|
2021-02-12 08:20:45 +01:00
|
|
|
"messages/<int:message_id>",
|
2021-09-20 10:34:10 +02:00
|
|
|
GET=(json_fetch_raw_message, {"allow_anonymous_user_web"}),
|
2021-02-12 08:19:30 +01:00
|
|
|
PATCH=update_message_backend,
|
|
|
|
|
DELETE=delete_message_backend,
|
|
|
|
|
),
|
2021-02-12 08:20:45 +01:00
|
|
|
rest_path("messages/render", POST=render_message_backend),
|
|
|
|
|
rest_path("messages/flags", POST=update_message_flags),
|
2022-11-10 01:06:37 +01:00
|
|
|
rest_path("messages/flags/narrow", POST=update_message_flags_for_narrow),
|
2021-02-12 08:20:45 +01:00
|
|
|
rest_path("messages/<int:message_id>/history", GET=get_message_edit_history),
|
|
|
|
|
rest_path("messages/matches_narrow", GET=messages_in_narrow_backend),
|
|
|
|
|
rest_path("users/me/subscriptions/properties", POST=update_subscription_properties_backend),
|
|
|
|
|
rest_path("users/me/subscriptions/<int:stream_id>", PATCH=update_subscriptions_property),
|
|
|
|
|
rest_path("submessage", POST=process_submessage),
|
2017-10-08 09:34:59 +02:00
|
|
|
# New endpoint for handling reactions.
|
2019-10-10 19:03:09 +02:00
|
|
|
# reactions -> zerver.view.reactions
|
|
|
|
|
# POST adds a reaction to a message
|
|
|
|
|
# DELETE removes a reaction from a message
|
2021-02-12 08:20:45 +01:00
|
|
|
rest_path("messages/<int:message_id>/reactions", POST=add_reaction, DELETE=remove_reaction),
|
2021-06-16 21:15:47 +02:00
|
|
|
# read_receipts -> zerver.views.read_receipts
|
|
|
|
|
rest_path("messages/<int:message_id>/read_receipts", GET=read_receipts),
|
2016-12-28 14:46:42 +01:00
|
|
|
# attachments -> zerver.views.attachments
|
2021-02-12 08:20:45 +01:00
|
|
|
rest_path("attachments", GET=list_by_user),
|
|
|
|
|
rest_path("attachments/<int:attachment_id>", DELETE=remove),
|
2016-10-12 20:57:59 +02:00
|
|
|
# typing -> zerver.views.typing
|
|
|
|
|
# POST sends a typing notification event to recipients
|
2021-02-12 08:20:45 +01:00
|
|
|
rest_path("typing", POST=send_notification_backend),
|
2016-06-25 11:05:59 +02:00
|
|
|
# user_uploads -> zerver.views.upload
|
2021-02-12 08:20:45 +01:00
|
|
|
rest_path("user_uploads", POST=upload_file_backend),
|
2021-02-12 08:19:30 +01:00
|
|
|
rest_path(
|
2021-02-12 08:20:45 +01:00
|
|
|
"user_uploads/<realm_id_str>/<path:filename>",
|
|
|
|
|
GET=(serve_file_url_backend, {"override_api_url_scheme"}),
|
2021-02-12 08:19:30 +01:00
|
|
|
),
|
2017-11-24 10:18:29 +01:00
|
|
|
# bot_storage -> zerver.views.storage
|
2021-02-12 08:20:45 +01:00
|
|
|
rest_path("bot_storage", PUT=update_storage, GET=get_storage, DELETE=remove_storage),
|
2016-06-25 01:04:14 +02:00
|
|
|
# Endpoint used by mobile devices to register their push
|
|
|
|
|
# notification credentials
|
2021-02-12 08:19:30 +01:00
|
|
|
rest_path(
|
2021-02-12 08:20:45 +01:00
|
|
|
"users/me/apns_device_token", POST=add_apns_device_token, DELETE=remove_apns_device_token
|
2021-02-12 08:19:30 +01:00
|
|
|
),
|
2021-02-12 08:20:45 +01:00
|
|
|
rest_path("users/me/android_gcm_reg_id", POST=add_android_reg_id, DELETE=remove_android_reg_id),
|
2022-02-08 00:13:33 +01:00
|
|
|
# users/*/presence => zerver.views.presence.
|
2021-02-12 08:20:45 +01:00
|
|
|
rest_path("users/me/presence", POST=update_active_status_backend),
|
2020-08-27 00:47:43 +02:00
|
|
|
# It's important that this sit after users/me/presence so that
|
|
|
|
|
# Django's URL resolution order doesn't break the
|
|
|
|
|
# /users/me/presence endpoint.
|
2021-01-04 19:36:00 +01:00
|
|
|
rest_path("users/<user_id_or_email>/presence", GET=get_presence_backend),
|
2021-02-12 08:20:45 +01:00
|
|
|
rest_path("realm/presence", GET=get_statuses_for_realm),
|
|
|
|
|
rest_path("users/me/status", POST=update_user_status_backend),
|
2017-11-01 10:04:16 +01:00
|
|
|
# user_groups -> zerver.views.user_groups
|
2021-02-12 08:20:45 +01:00
|
|
|
rest_path("user_groups", GET=get_user_group),
|
|
|
|
|
rest_path("user_groups/create", POST=add_user_group),
|
|
|
|
|
rest_path("user_groups/<int:user_group_id>", PATCH=edit_user_group, DELETE=delete_user_group),
|
2022-03-24 11:39:57 +01:00
|
|
|
rest_path(
|
|
|
|
|
"user_groups/<int:user_group_id>/members",
|
|
|
|
|
GET=get_user_group_members,
|
|
|
|
|
POST=update_user_group_backend,
|
|
|
|
|
),
|
2022-04-04 13:59:25 +02:00
|
|
|
rest_path(
|
|
|
|
|
"user_groups/<int:user_group_id>/subgroups",
|
|
|
|
|
POST=update_subgroups_of_user_group,
|
|
|
|
|
GET=get_subgroups_of_user_group,
|
|
|
|
|
),
|
2022-03-18 14:38:11 +01:00
|
|
|
rest_path(
|
|
|
|
|
"user_groups/<int:user_group_id>/members/<int:user_id>", GET=get_is_user_group_member
|
|
|
|
|
),
|
2016-06-25 00:54:47 +02:00
|
|
|
# users/me -> zerver.views.user_settings
|
2021-02-12 08:20:45 +01:00
|
|
|
rest_path("users/me/avatar", POST=set_avatar_backend, DELETE=delete_avatar_backend),
|
2017-01-24 01:48:35 +01:00
|
|
|
# users/me/hotspots -> zerver.views.hotspots
|
2021-02-12 08:19:30 +01:00
|
|
|
rest_path(
|
2021-02-12 08:20:45 +01:00
|
|
|
"users/me/hotspots",
|
2021-02-12 08:19:30 +01:00
|
|
|
POST=(
|
|
|
|
|
mark_hotspot_as_read,
|
|
|
|
|
# This endpoint is low priority for documentation as
|
2021-05-14 00:16:30 +02:00
|
|
|
# it is part of the web app-specific tutorial.
|
2021-02-12 08:20:45 +01:00
|
|
|
{"intentionally_undocumented"},
|
2021-02-12 08:19:30 +01:00
|
|
|
),
|
|
|
|
|
),
|
2017-10-09 22:55:38 +02:00
|
|
|
# users/me/tutorial_status -> zerver.views.tutorial
|
2021-02-12 08:19:30 +01:00
|
|
|
rest_path(
|
2021-02-12 08:20:45 +01:00
|
|
|
"users/me/tutorial_status",
|
2021-02-12 08:19:30 +01:00
|
|
|
POST=(
|
|
|
|
|
set_tutorial_status,
|
|
|
|
|
# This is a relic of an old Zulip tutorial model and
|
|
|
|
|
# should be deleted.
|
2021-02-12 08:20:45 +01:00
|
|
|
{"intentionally_undocumented"},
|
2021-02-12 08:19:30 +01:00
|
|
|
),
|
|
|
|
|
),
|
2016-12-22 18:29:14 +01:00
|
|
|
# settings -> zerver.views.user_settings
|
2021-02-12 08:20:45 +01:00
|
|
|
rest_path("settings", PATCH=json_change_settings),
|
2021-07-07 22:08:11 +02:00
|
|
|
# These next two are legacy aliases for /settings, from before
|
|
|
|
|
# we merged the endpoints. They are documented in the `/json/settings`
|
|
|
|
|
# documentation, rather than having dedicated pages.
|
|
|
|
|
rest_path("settings/display", PATCH=(json_change_settings, {"intentionally_undocumented"})),
|
|
|
|
|
rest_path(
|
|
|
|
|
"settings/notifications", PATCH=(json_change_settings, {"intentionally_undocumented"})
|
|
|
|
|
),
|
2016-06-25 00:54:47 +02:00
|
|
|
# users/me/alert_words -> zerver.views.alert_words
|
2021-02-12 08:19:30 +01:00
|
|
|
rest_path(
|
2021-02-12 08:20:45 +01:00
|
|
|
"users/me/alert_words",
|
2021-02-12 08:19:30 +01:00
|
|
|
GET=list_alert_words,
|
|
|
|
|
POST=add_alert_words,
|
|
|
|
|
DELETE=remove_alert_words,
|
|
|
|
|
),
|
2017-03-17 10:07:22 +01:00
|
|
|
# users/me/custom_profile_data -> zerver.views.custom_profile_data
|
2021-02-12 08:19:30 +01:00
|
|
|
rest_path(
|
2021-02-12 08:20:45 +01:00
|
|
|
"users/me/profile_data",
|
2021-02-12 08:19:30 +01:00
|
|
|
PATCH=update_user_custom_profile_data,
|
|
|
|
|
DELETE=remove_user_custom_profile_data,
|
|
|
|
|
),
|
|
|
|
|
rest_path(
|
2021-02-12 08:20:45 +01:00
|
|
|
"users/me/<int:stream_id>/topics", GET=(get_topics_backend, {"allow_anonymous_user_web"})
|
2021-02-12 08:19:30 +01:00
|
|
|
),
|
2016-06-25 00:54:47 +02:00
|
|
|
# streams -> zerver.views.streams
|
2016-10-25 22:45:39 +02:00
|
|
|
# (this API is only used externally)
|
2021-02-12 08:20:45 +01:00
|
|
|
rest_path("streams", GET=get_streams_backend),
|
2020-10-23 02:43:28 +02:00
|
|
|
# GET returns `stream_id`, stream name should be encoded in the URL query (in `stream` param)
|
2021-02-12 08:20:45 +01:00
|
|
|
rest_path("get_stream_id", GET=json_get_stream_id),
|
2015-11-23 14:35:16 +01:00
|
|
|
# GET returns "stream info" (undefined currently?), HEAD returns whether stream exists (200 or 404)
|
2021-02-12 08:20:45 +01:00
|
|
|
rest_path("streams/<int:stream_id>/members", GET=get_subscribers_backend),
|
2021-02-12 08:19:30 +01:00
|
|
|
rest_path(
|
2022-05-18 13:54:35 +02:00
|
|
|
"streams/<int:stream_id>",
|
|
|
|
|
GET=get_stream_backend,
|
|
|
|
|
PATCH=update_stream_backend,
|
|
|
|
|
DELETE=deactivate_stream_backend,
|
2021-02-12 08:19:30 +01:00
|
|
|
),
|
2019-01-18 17:40:54 +01:00
|
|
|
# Delete topic in stream
|
2021-02-12 08:20:45 +01:00
|
|
|
rest_path("streams/<int:stream_id>/delete_topic", POST=delete_in_topic),
|
|
|
|
|
rest_path("default_streams", POST=add_default_stream, DELETE=remove_default_stream),
|
|
|
|
|
rest_path("default_stream_groups/create", POST=create_default_stream_group),
|
2021-02-12 08:19:30 +01:00
|
|
|
rest_path(
|
2021-02-12 08:20:45 +01:00
|
|
|
"default_stream_groups/<int:group_id>",
|
2021-02-12 08:19:30 +01:00
|
|
|
PATCH=update_default_stream_group_info,
|
|
|
|
|
DELETE=remove_default_stream_group,
|
|
|
|
|
),
|
|
|
|
|
rest_path(
|
2021-02-12 08:20:45 +01:00
|
|
|
"default_stream_groups/<int:group_id>/streams", PATCH=update_default_stream_group_streams
|
2021-02-12 08:19:30 +01:00
|
|
|
),
|
2015-11-23 14:35:16 +01:00
|
|
|
# GET lists your streams, POST bulk adds, PATCH bulk modifies/removes
|
2021-02-12 08:19:30 +01:00
|
|
|
rest_path(
|
2021-02-12 08:20:45 +01:00
|
|
|
"users/me/subscriptions",
|
2021-02-12 08:19:30 +01:00
|
|
|
GET=list_subscriptions_backend,
|
|
|
|
|
POST=add_subscriptions_backend,
|
|
|
|
|
PATCH=update_subscriptions_backend,
|
|
|
|
|
DELETE=remove_subscriptions_backend,
|
|
|
|
|
),
|
2023-02-03 11:40:06 +01:00
|
|
|
# topic-muting -> zerver.views.user_topics
|
2023-03-31 21:18:12 +02:00
|
|
|
# (deprecated and will be removed once clients are migrated to use '/user_topics')
|
2021-02-12 08:20:45 +01:00
|
|
|
rest_path("users/me/subscriptions/muted_topics", PATCH=update_muted_topic),
|
2023-03-31 21:18:12 +02:00
|
|
|
# used to update the personal preferences for a topic -> zerver.views.user_topics
|
|
|
|
|
rest_path("user_topics", POST=update_user_topic),
|
2023-02-03 11:40:06 +01:00
|
|
|
# user-muting -> zerver.views.user_mutes
|
2021-03-27 12:23:32 +01:00
|
|
|
rest_path("users/me/muted_users/<int:muted_user_id>", POST=mute_user, DELETE=unmute_user),
|
2016-06-24 02:26:09 +02:00
|
|
|
# used to register for an event queue in tornado
|
2022-05-03 23:48:52 +02:00
|
|
|
rest_path("register", POST=(events_register_backend, {"allow_anonymous_user_web"})),
|
2016-11-27 06:50:54 +01:00
|
|
|
# events -> zerver.tornado.views
|
2021-02-12 08:20:45 +01:00
|
|
|
rest_path("events", GET=get_events, DELETE=cleanup_event_queue),
|
2017-10-16 22:07:19 +02:00
|
|
|
# report -> zerver.views.report
|
2019-07-01 13:22:54 +02:00
|
|
|
#
|
|
|
|
|
# These endpoints are for internal error/performance reporting
|
2021-05-14 00:16:30 +02:00
|
|
|
# from the browser to the web app, and we don't expect to ever
|
2019-07-01 13:22:54 +02:00
|
|
|
# include in our API documentation.
|
2021-02-12 08:20:45 +01:00
|
|
|
rest_path("report/send_times", POST=(report_send_times, {"intentionally_undocumented"})),
|
2021-02-12 08:19:30 +01:00
|
|
|
rest_path(
|
2021-02-12 08:20:45 +01:00
|
|
|
"report/narrow_times",
|
|
|
|
|
POST=(report_narrow_times, {"allow_anonymous_user_web", "intentionally_undocumented"}),
|
2021-02-12 08:19:30 +01:00
|
|
|
),
|
|
|
|
|
rest_path(
|
2021-02-12 08:20:45 +01:00
|
|
|
"report/unnarrow_times",
|
|
|
|
|
POST=(report_unnarrow_times, {"allow_anonymous_user_web", "intentionally_undocumented"}),
|
2021-02-12 08:19:30 +01:00
|
|
|
),
|
2018-12-28 20:45:54 +01:00
|
|
|
# Used to generate a Zoom video call URL
|
2021-02-12 08:20:45 +01:00
|
|
|
rest_path("calls/zoom/create", POST=make_zoom_video_call),
|
2021-07-06 00:23:51 +02:00
|
|
|
# Used to generate a BigBlueButton video call URL
|
2021-02-12 08:20:45 +01:00
|
|
|
rest_path("calls/bigbluebutton/create", GET=get_bigbluebutton_url),
|
2019-08-01 19:59:36 +02:00
|
|
|
# export/realm -> zerver.views.realm_export
|
2021-02-12 08:20:45 +01:00
|
|
|
rest_path("export/realm", POST=export_realm, GET=get_realm_exports),
|
|
|
|
|
rest_path("export/realm/<int:export_id>", DELETE=delete_realm_export),
|
2016-06-24 02:26:09 +02:00
|
|
|
]
|
2013-11-05 23:50:19 +01:00
|
|
|
|
2020-09-12 04:18:53 +02:00
|
|
|
integrations_view = IntegrationView.as_view()
|
|
|
|
|
|
2017-10-18 07:09:22 +02:00
|
|
|
# These views serve pages (HTML). As such, their internationalization
|
2020-10-23 02:43:28 +02:00
|
|
|
# must depend on the URL.
|
2017-10-18 07:09:22 +02:00
|
|
|
#
|
|
|
|
|
# If you're adding a new page to the website (as opposed to a new
|
|
|
|
|
# endpoint for use by code), you should add it here.
|
|
|
|
|
i18n_urls = [
|
2021-02-12 08:20:45 +01:00
|
|
|
path("", home, name="home"),
|
2017-10-18 07:09:22 +02:00
|
|
|
# We have a desktop-specific landing page in case we change our /
|
|
|
|
|
# to not log in in the future. We don't want to require a new
|
|
|
|
|
# desktop app build for everyone in that case
|
2021-02-12 08:20:45 +01:00
|
|
|
path("desktop_home/", desktop_home),
|
2019-08-27 04:56:51 +02:00
|
|
|
# Backwards-compatibility (legacy) Google auth URL for the mobile
|
|
|
|
|
# apps; see https://github.com/zulip/zulip/issues/13081 for
|
|
|
|
|
# background. We can remove this once older versions of the
|
|
|
|
|
# mobile app are no longer present in the wild.
|
2021-02-12 08:20:45 +01:00
|
|
|
path("accounts/login/google/", start_social_login, {"backend": "google"}),
|
|
|
|
|
path("accounts/login/start/sso/", start_remote_user_sso, name="start-login-sso"),
|
|
|
|
|
path("accounts/login/sso/", remote_user_sso, name="login-sso"),
|
|
|
|
|
path("accounts/login/jwt/", remote_user_jwt),
|
|
|
|
|
path("accounts/login/social/<backend>", start_social_login, name="login-social"),
|
|
|
|
|
path("accounts/login/social/<backend>/<extra_arg>", start_social_login, name="login-social"),
|
|
|
|
|
path("accounts/register/social/<backend>", start_social_signup, name="signup-social"),
|
2021-02-12 08:19:30 +01:00
|
|
|
path(
|
2021-02-12 08:20:45 +01:00
|
|
|
"accounts/register/social/<backend>/<extra_arg>", start_social_signup, name="signup-social"
|
2021-02-12 08:19:30 +01:00
|
|
|
),
|
2021-02-12 08:20:45 +01:00
|
|
|
path("accounts/login/subdomain/<token>", log_into_subdomain),
|
2019-03-25 22:12:51 +01:00
|
|
|
# We have two entries for accounts/login; only the first one is
|
|
|
|
|
# used for URL resolution. The second here is to allow
|
2020-09-22 02:54:44 +02:00
|
|
|
# reverse("login") in templates to
|
2019-03-25 22:12:51 +01:00
|
|
|
# return `/accounts/login/`.
|
2021-02-12 08:20:45 +01:00
|
|
|
path("accounts/login/", login_page, {"template_name": "zerver/login.html"}, name="login_page"),
|
|
|
|
|
path("accounts/login/", LoginView.as_view(template_name="zerver/login.html"), name="login"),
|
|
|
|
|
path("accounts/logout/", logout_then_login),
|
|
|
|
|
path("accounts/webathena_kerberos_login/", webathena_kerberos_login),
|
|
|
|
|
path("accounts/password/reset/", password_reset, name="password_reset"),
|
2021-02-12 08:19:30 +01:00
|
|
|
path(
|
2021-02-12 08:20:45 +01:00
|
|
|
"accounts/password/reset/done/",
|
|
|
|
|
PasswordResetDoneView.as_view(template_name="zerver/reset_emailed.html"),
|
2021-02-12 08:19:30 +01:00
|
|
|
),
|
|
|
|
|
path(
|
2021-02-12 08:20:45 +01:00
|
|
|
"accounts/password/reset/<uidb64>/<token>/",
|
2021-02-12 08:19:30 +01:00
|
|
|
PasswordResetConfirmView.as_view(
|
2021-02-12 08:20:45 +01:00
|
|
|
success_url="/accounts/password/done/",
|
|
|
|
|
template_name="zerver/reset_confirm.html",
|
2021-02-12 08:19:30 +01:00
|
|
|
form_class=LoggingSetPasswordForm,
|
|
|
|
|
),
|
2021-02-12 08:20:45 +01:00
|
|
|
name="password_reset_confirm",
|
2021-02-12 08:19:30 +01:00
|
|
|
),
|
|
|
|
|
path(
|
2021-02-12 08:20:45 +01:00
|
|
|
"accounts/password/done/",
|
|
|
|
|
PasswordResetCompleteView.as_view(template_name="zerver/reset_done.html"),
|
2021-02-12 08:19:30 +01:00
|
|
|
),
|
2021-02-12 08:20:45 +01:00
|
|
|
path("accounts/deactivated/", show_deactivation_notice),
|
2018-08-12 22:09:34 +02:00
|
|
|
# Displays digest email content in browser.
|
2021-02-12 08:20:45 +01:00
|
|
|
path("digest/", digest_page),
|
2017-10-18 07:09:22 +02:00
|
|
|
# Registration views, require a confirmation ID.
|
2021-02-12 08:20:45 +01:00
|
|
|
path("accounts/home/", accounts_home),
|
2021-02-12 08:19:30 +01:00
|
|
|
path(
|
2023-01-20 08:22:48 +01:00
|
|
|
"accounts/send_confirm/",
|
|
|
|
|
signup_send_confirm,
|
2021-02-12 08:20:45 +01:00
|
|
|
name="signup_send_confirm",
|
2021-02-12 08:19:30 +01:00
|
|
|
),
|
|
|
|
|
path(
|
2023-01-20 08:22:48 +01:00
|
|
|
"accounts/new/send_confirm/",
|
2022-12-08 11:08:55 +01:00
|
|
|
new_realm_send_confirm,
|
2021-02-12 08:20:45 +01:00
|
|
|
name="new_realm_send_confirm",
|
2021-02-12 08:19:30 +01:00
|
|
|
),
|
2021-02-12 08:20:45 +01:00
|
|
|
path("accounts/register/", accounts_register, name="accounts_register"),
|
2023-02-24 09:08:26 +01:00
|
|
|
path("realm/register/", realm_register, name="realm_register"),
|
2021-02-12 08:19:30 +01:00
|
|
|
path(
|
2021-02-12 08:20:45 +01:00
|
|
|
"accounts/do_confirm/<confirmation_key>",
|
2021-11-29 16:20:59 +01:00
|
|
|
get_prereg_key_and_redirect,
|
|
|
|
|
name="get_prereg_key_and_redirect",
|
2021-02-12 08:19:30 +01:00
|
|
|
),
|
|
|
|
|
path(
|
2021-02-12 08:20:45 +01:00
|
|
|
"accounts/confirm_new_email/<confirmation_key>",
|
2021-02-12 08:19:30 +01:00
|
|
|
confirm_email_change,
|
2021-02-12 08:20:45 +01:00
|
|
|
name="confirm_email_change",
|
2021-02-12 08:19:30 +01:00
|
|
|
),
|
2017-10-18 07:09:22 +02:00
|
|
|
# Email unsubscription endpoint. Allows for unsubscribing from various types of emails,
|
|
|
|
|
# including the welcome emails (day 1 & 2), missed PMs, etc.
|
2021-02-12 08:19:30 +01:00
|
|
|
path(
|
2021-02-12 08:20:45 +01:00
|
|
|
"accounts/unsubscribe/<email_type>/<confirmation_key>",
|
2021-02-12 08:19:30 +01:00
|
|
|
email_unsubscribe,
|
2021-02-12 08:20:45 +01:00
|
|
|
name="unsubscribe",
|
2021-02-12 08:19:30 +01:00
|
|
|
),
|
2017-10-18 07:09:22 +02:00
|
|
|
# Portico-styled page used to provide email confirmation of terms acceptance.
|
2021-02-12 08:20:45 +01:00
|
|
|
path("accounts/accept_terms/", accounts_accept_terms, name="accept_terms"),
|
2017-10-18 07:09:22 +02:00
|
|
|
# Find your account
|
2021-02-12 08:20:45 +01:00
|
|
|
path("accounts/find/", find_account, name="find_account"),
|
2018-08-25 14:06:17 +02:00
|
|
|
# Go to organization subdomain
|
2021-02-12 08:20:45 +01:00
|
|
|
path("accounts/go/", realm_redirect, name="realm_redirect"),
|
2020-10-23 02:43:28 +02:00
|
|
|
# Realm creation
|
2021-02-12 08:20:45 +01:00
|
|
|
path("new/", create_realm),
|
|
|
|
|
path("new/<creation_key>", create_realm, name="create_realm"),
|
2020-10-23 02:43:28 +02:00
|
|
|
# Realm reactivation
|
2021-02-12 08:20:45 +01:00
|
|
|
path("reactivate/<confirmation_key>", realm_reactivation, name="realm_reactivation"),
|
2017-10-18 07:09:22 +02:00
|
|
|
# Login/registration
|
2021-02-12 08:20:45 +01:00
|
|
|
path("register/", accounts_home, name="register"),
|
|
|
|
|
path("login/", login_page, {"template_name": "zerver/login.html"}, name="login_page"),
|
|
|
|
|
path("join/<confirmation_key>/", accounts_home_from_multiuse_invite, name="join"),
|
2019-11-16 09:26:28 +01:00
|
|
|
# Used to generate a Zoom video call URL
|
2021-02-12 08:20:45 +01:00
|
|
|
path("calls/zoom/register", register_zoom_user),
|
|
|
|
|
path("calls/zoom/complete", complete_zoom_user),
|
|
|
|
|
path("calls/zoom/deauthorize", deauthorize_zoom_user),
|
2021-07-06 00:23:51 +02:00
|
|
|
# Used to join a BigBlueButton video call
|
2021-02-12 08:20:45 +01:00
|
|
|
path("calls/bigbluebutton/join", join_bigbluebutton),
|
2017-10-18 07:09:22 +02:00
|
|
|
# API and integrations documentation
|
2021-02-12 08:20:45 +01:00
|
|
|
path("integrations/doc-html/<integration_name>", integration_doc),
|
|
|
|
|
path("integrations/", integrations_view),
|
|
|
|
|
path("integrations/<path:path>", integrations_view),
|
2017-10-18 07:09:22 +02:00
|
|
|
]
|
|
|
|
|
|
|
|
|
|
# Make a copy of i18n_urls so that they appear without prefix for english
|
2021-08-15 18:32:51 +02:00
|
|
|
urls: List[Union[URLPattern, URLResolver]] = list(i18n_urls)
|
2017-10-18 07:09:22 +02:00
|
|
|
|
2016-06-25 00:33:50 +02:00
|
|
|
# Include the dual-use patterns twice
|
2016-06-25 00:38:41 +02:00
|
|
|
urls += [
|
2021-02-12 08:20:45 +01:00
|
|
|
path("api/v1/", include(v1_api_and_json_patterns)),
|
|
|
|
|
path("json/", include(v1_api_and_json_patterns)),
|
2016-06-25 00:33:50 +02:00
|
|
|
]
|
|
|
|
|
|
2016-06-27 16:41:58 +02:00
|
|
|
# user_uploads -> zerver.views.upload.serve_file_backend
|
|
|
|
|
#
|
2020-10-23 02:43:28 +02:00
|
|
|
# This URL is an exception to the URL naming schemes for endpoints. It
|
2016-06-27 16:41:58 +02:00
|
|
|
# supports both API and session cookie authentication, using a single
|
|
|
|
|
# URL for both (not 'api/v1/' or 'json/' prefix). This is required to
|
|
|
|
|
# easily support the mobile apps fetching uploaded files without
|
|
|
|
|
# having to rewrite URLs, and is implemented using the
|
|
|
|
|
# 'override_api_url_scheme' flag passed to rest_dispatch
|
2018-08-13 19:09:09 +02:00
|
|
|
urls += [
|
2021-02-12 08:19:30 +01:00
|
|
|
path(
|
2021-02-12 08:20:45 +01:00
|
|
|
"user_uploads/temporary/<token>/<filename>",
|
uploads: Serve S3 uploads directly from nginx.
When file uploads are stored in S3, this means that Zulip serves as a
302 to S3. Because browsers do not cache redirects, this means that
no image contents can be cached -- and upon every page load or reload,
every recently-posted image must be re-fetched. This incurs extra
load on the Zulip server, as well as potentially excessive bandwidth
usage from S3, and on the client's connection.
Switch to fetching the content from S3 in nginx, and serving the
content from nginx. These have `Cache-control: private, immutable`
headers set on the response, allowing browsers to cache them locally.
Because nginx fetching from S3 can be slow, and requests for uploads
will generally be bunched around when a message containing them are
first posted, we instruct nginx to cache the contents locally. This
is safe because uploaded file contents are immutable; access control
is still mediated by Django. The nginx cache key is the URL without
query parameters, as those parameters include a time-limited signed
authentication parameter which lets nginx fetch the non-public file.
This adds a number of nginx-level configuration parameters to control
the caching which nginx performs, including the amount of in-memory
index for he cache, the maximum storage of the cache on disk, and how
long data is retained in the cache. The currently-chosen figures are
reasonable for small to medium deployments.
The most notable effect of this change is in allowing browsers to
cache uploaded image content; however, while there will be many fewer
requests, it also has an improvement on request latency. The
following tests were done with a non-AWS client in SFO, a server and
S3 storage in us-east-1, and with 100 requests after 10 requests of
warm-up (to fill the nginx cache). The mean and standard deviation
are shown.
| | Redirect to S3 | Caching proxy, hot | Caching proxy, cold |
| ----------------- | ------------------- | ------------------- | ------------------- |
| Time in Django | 263.0 ms ± 28.3 ms | 258.0 ms ± 12.3 ms | 258.0 ms ± 12.3 ms |
| Small file (842b) | 586.1 ms ± 21.1 ms | 266.1 ms ± 67.4 ms | 288.6 ms ± 17.7 ms |
| Large file (660k) | 959.6 ms ± 137.9 ms | 609.5 ms ± 13.0 ms | 648.1 ms ± 43.2 ms |
The hot-cache performance is faster for both large and small files,
since it saves the client the time having to make a second request to
a separate host. This performance improvement remains at least 100ms
even if the client is on the same coast as the server.
Cold nginx caches are only slightly slower than hot caches, because
VPC access to S3 endpoints is extremely fast (assuming it is in the
same region as the host), and nginx can pool connections to S3 and
reuse them.
However, all of the 648ms taken to serve a cold-cache large file is
occupied in nginx, as opposed to the only 263ms which was spent in
nginx when using redirects to S3. This means that to overall spend
less time responding to uploaded-file requests in nginx, clients will
need to find files in their local cache, and skip making an
uploaded-file request, at least 60% of the time. Modeling shows a
reduction in the number of client requests by about 70% - 80%.
The `Content-Disposition` header logic can now also be entirely shared
with the local-file codepath, as can the `url_only` path used by
mobile clients. While we could provide the direct-to-S3 temporary
signed URL to mobile clients, we choose to provide the
served-from-Zulip signed URL, to better control caching headers on it,
and greater consistency. In doing so, we adjust the salt used for the
URL; since these URLs are only valid for 60s, the effect of this salt
change is minimal.
2022-11-22 20:41:35 +01:00
|
|
|
serve_file_unauthed_from_token,
|
|
|
|
|
name="file_unauthed_from_token",
|
2021-02-12 08:19:30 +01:00
|
|
|
),
|
2022-03-22 04:38:18 +01:00
|
|
|
rest_path(
|
|
|
|
|
"user_uploads/download/<realm_id_str>/<path:filename>",
|
|
|
|
|
GET=(serve_file_download_backend, {"override_api_url_scheme"}),
|
|
|
|
|
),
|
2021-02-12 08:19:30 +01:00
|
|
|
rest_path(
|
2021-02-12 08:20:45 +01:00
|
|
|
"user_uploads/<realm_id_str>/<path:filename>",
|
2021-11-02 15:42:58 +01:00
|
|
|
GET=(serve_file_backend, {"override_api_url_scheme", "allow_anonymous_user_web"}),
|
2021-02-12 08:19:30 +01:00
|
|
|
),
|
2021-05-07 00:38:24 +02:00
|
|
|
# This endpoint redirects to camo; it requires an exception for the
|
|
|
|
|
# same reason.
|
2021-11-02 15:42:58 +01:00
|
|
|
rest_path(
|
|
|
|
|
"thumbnail",
|
|
|
|
|
GET=(backend_serve_thumbnail, {"override_api_url_scheme", "allow_anonymous_user_web"}),
|
|
|
|
|
),
|
markdown: Remove !avatar() and !gravatar() syntax.
This particular commit has been a long time coming. For reference,
!avatar(email) was an undocumented syntax that simply rendered an
inline 50px avatar for a user in a message, essentially allowing
you to create a user pill like:
`!avatar(alice@example.com) Alice: hey!`
---
Reimplementation
If we decide to reimplement this or a similar feature in the future,
we could use something like `<avatar:userid>` syntax which is more
in line with creating links in markdown. Even then, it would not be
a good idea to add this instead of supporting inline images directly.
Since any usecases of such a syntax are in automation, we do not need
to make it userfriendly and something like the following is a better
implementation that doesn't need a custom syntax:
` Alice: hey!`
---
History
We initially added this syntax back in 2012 and it was 'deprecated'
from the get go. Here's what the original commit had to say about
the new syntax:
> We'll use this internally for the commit bot. We might eventually
> disable it for external users.
We eventually did start using this for our github integrations in 2013
but since then, those integrations have been neglected in favor of
our GitHub webhooks which do not use this syntax.
When we copied `!gravatar` to add the `!avatar` syntax, we also noted
that we want to deprecate the `!gravatar` syntax entirely - in 2013!
Since then, we haven't advertised either of these syntaxes anywhere
in our docs, and the only two places where this syntax remains is
our game bots that could easily do without these, and the git commit
integration that we have deprecated anyway.
We do not have any evidence of someone asking about this syntax on
chat.zulip.org when developing an integration and rightfully so- only
the people who work on Zulip (and specifically, markdown) are likely
to stumble upon it and try it out.
This is also the only peice of code due to which we had to look up
emails -> userid mapping in our backend markdown. By removing this,
we entirely remove the backend markdown's dependency on user emails
to render messages.
---
Relevant commits:
- Oct 2012, Initial commit c31462c2782a33886e737cf33424a36a95c81f97
- Nov 2013, Update commit bot 968c393826f8846065c5c880427328f6e534c2f5
- Nov 2013, Add avatar syntax 761c0a0266669aca82d134716a4d6b6e33d541fc
- Sep 2017, Avoid email use c3032a7fe8ed49b011e0d242f4b8a7d756b9f647
- Apr 2019, Remove from webhook 674fcfcce1fcf35bdc57031a1025ef169d495d36
2020-07-06 23:01:38 +02:00
|
|
|
# Avatars have the same constraint because their URLs are included
|
|
|
|
|
# in API data structures used by both the mobile and web clients.
|
2021-02-12 08:19:30 +01:00
|
|
|
rest_path(
|
2021-11-01 12:21:17 +01:00
|
|
|
"avatar/<email_or_id>",
|
|
|
|
|
GET=(avatar, {"override_api_url_scheme", "allow_anonymous_user_web"}),
|
|
|
|
|
),
|
|
|
|
|
rest_path(
|
|
|
|
|
"avatar/<email_or_id>/medium",
|
2022-08-15 21:50:30 +02:00
|
|
|
GET=(
|
|
|
|
|
avatar_medium,
|
|
|
|
|
{"override_api_url_scheme", "allow_anonymous_user_web"},
|
|
|
|
|
),
|
2021-02-12 08:19:30 +01:00
|
|
|
),
|
2022-12-06 22:24:43 +01:00
|
|
|
path(
|
|
|
|
|
"user_avatars/<path:path>",
|
|
|
|
|
serve_local_avatar_unauthed,
|
|
|
|
|
name="local_avatar_unauthed",
|
|
|
|
|
),
|
2018-08-13 19:09:09 +02:00
|
|
|
]
|
2016-06-27 16:41:58 +02:00
|
|
|
|
2020-10-23 02:43:28 +02:00
|
|
|
# This URL serves as a way to receive CSP violation reports from the users.
|
2018-04-11 05:50:08 +02:00
|
|
|
# We use this endpoint to just log these reports.
|
2020-04-10 05:28:54 +02:00
|
|
|
urls += [
|
2021-02-12 08:20:45 +01:00
|
|
|
path("report/csp_violations", report_csp_violations),
|
2020-04-10 05:28:54 +02:00
|
|
|
]
|
2018-03-08 09:37:09 +01:00
|
|
|
|
2016-06-25 18:30:30 +02:00
|
|
|
# Incoming webhook URLs
|
2020-10-23 02:43:28 +02:00
|
|
|
# We don't create URLs for particular Git integrations here
|
2016-11-14 21:06:39 +01:00
|
|
|
# because of generic one below
|
2016-07-25 22:12:12 +02:00
|
|
|
for incoming_webhook in WEBHOOK_INTEGRATIONS:
|
2022-07-18 22:10:32 +02:00
|
|
|
urls.append(incoming_webhook.url_object)
|
2016-11-14 21:06:39 +01:00
|
|
|
|
2018-01-05 21:30:55 +01:00
|
|
|
# Desktop-specific authentication URLs
|
|
|
|
|
urls += [
|
2021-02-12 08:20:45 +01:00
|
|
|
rest_path("json/fetch_api_key", POST=json_fetch_api_key),
|
2018-01-05 21:30:55 +01:00
|
|
|
]
|
|
|
|
|
|
2016-06-25 18:30:30 +02:00
|
|
|
# Mobile-specific authentication URLs
|
|
|
|
|
urls += [
|
2019-08-20 00:33:09 +02:00
|
|
|
# Used as a global check by all mobile clients, which currently send
|
2020-06-08 23:04:39 +02:00
|
|
|
# requests to https://zulip.com/compatibility almost immediately after
|
2019-08-20 00:33:09 +02:00
|
|
|
# starting up.
|
2021-02-12 08:20:45 +01:00
|
|
|
path("compatibility", check_global_compatibility),
|
2019-08-20 00:33:09 +02:00
|
|
|
]
|
|
|
|
|
|
|
|
|
|
v1_api_mobile_patterns = [
|
2017-05-04 01:13:56 +02:00
|
|
|
# This json format view used by the mobile apps lists which
|
|
|
|
|
# authentication backends the server allows as well as details
|
2018-12-06 02:49:34 +01:00
|
|
|
# like the requested subdomains'd realm icon (if known) and
|
|
|
|
|
# server-specific compatibility.
|
2021-02-12 08:20:45 +01:00
|
|
|
path("server_settings", api_get_server_settings),
|
2016-06-25 18:30:30 +02:00
|
|
|
# This json format view used by the mobile apps accepts a username
|
|
|
|
|
# password/pair and returns an API key.
|
2021-02-12 08:20:45 +01:00
|
|
|
path("fetch_api_key", api_fetch_api_key),
|
2022-02-18 21:49:17 +01:00
|
|
|
# The endpoint for regenerating and obtaining a new API key
|
|
|
|
|
# should only be available by authenticating with the current
|
|
|
|
|
# API key - as we consider access to the API key sensitive
|
|
|
|
|
# and just having a logged-in session should be insufficient.
|
|
|
|
|
rest_path("users/me/api_key/regenerate", POST=regenerate_api_key),
|
2023-04-07 21:00:27 +02:00
|
|
|
# This view accepts a JWT containing an email and returns an API key
|
|
|
|
|
# and the details for a single user.
|
|
|
|
|
path("jwt/fetch_api_key", jwt_fetch_api_key),
|
2019-08-20 00:33:09 +02:00
|
|
|
]
|
2016-06-25 18:30:30 +02:00
|
|
|
|
2017-04-18 17:28:55 +02:00
|
|
|
# View for uploading messages from email mirror
|
|
|
|
|
urls += [
|
2021-02-12 08:20:45 +01:00
|
|
|
path("email_mirror_message", email_mirror_message),
|
2017-04-18 17:28:55 +02:00
|
|
|
]
|
|
|
|
|
|
2016-04-27 06:39:34 +02:00
|
|
|
# Include URL configuration files for site-specified extra installed
|
|
|
|
|
# Django apps
|
|
|
|
|
for app_name in settings.EXTRA_INSTALLED_APPS:
|
|
|
|
|
app_dir = os.path.join(settings.DEPLOY_ROOT, app_name)
|
2021-02-12 08:20:45 +01:00
|
|
|
if os.path.exists(os.path.join(app_dir, "urls.py")):
|
|
|
|
|
urls += [path("", include(f"{app_name}.urls"))]
|
2020-06-09 00:25:09 +02:00
|
|
|
i18n_urls += import_string(f"{app_name}.urls.i18n_urlpatterns")
|
2013-07-05 20:04:47 +02:00
|
|
|
|
2016-06-25 00:38:41 +02:00
|
|
|
# Tornado views
|
|
|
|
|
urls += [
|
2012-10-09 22:21:03 +02:00
|
|
|
# Used internally for communication between Django and Tornado processes
|
tornado: Rewrite Django integration to duplicate less code.
Since essentially the first use of Tornado in Zulip, we've been
maintaining our Tornado+Django system, AsyncDjangoHandler, with
several hundred lines of Django code copied into it.
The goal for that code was simple: We wanted a way to use our Django
middleware (for code sharing reasons) inside a Tornado process (since
we wanted to use Tornado for our async events system).
As part of the Django 2.2.x upgrade, I looked at upgrading this
implementation to be based off modern Django, and it's definitely
possible to do that:
* Continue forking load_middleware to save response middleware.
* Continue manually running the Django response middleware.
* Continue working out a hack involving copying all of _get_response
to change a couple lines allowing us our Tornado code to not
actually return the Django HttpResponse so we can long-poll. The
previous hack of returning None stopped being viable with the Django 2.2
MiddlewareMixin.__call__ implementation.
But I decided to take this opportunity to look at trying to avoid
copying material Django code, and there is a way to do it:
* Replace RespondAsynchronously with a response.asynchronous attribute
on the HttpResponse; this allows Django to run its normal plumbing
happily in a way that should be stable over time, and then we
proceed to discard the response inside the Tornado `get()` method to
implement long-polling. (Better yet might be raising an
exception?). This lets us eliminate maintaining a patched copy of
_get_response.
* Removing the @asynchronous decorator, which didn't add anything now
that we only have one API endpoint backend (with two frontend call
points) that could call into this. Combined with the last bullet,
this lets us remove a significant hack from our
never_cache_responses function.
* Calling the normal Django `get_response` method from zulip_finish
after creating a duplicate request to process, rather than writing
totally custom code to do that. This lets us eliminate maintaining
a patched copy of Django's load_middleware.
* Adding detailed comments explaining how this is supposed to work,
what problems we encounter, and how we solve various problems, which
is critical to being able to modify this code in the future.
A key advantage of these changes is that the exact same code should
work on Django 1.11, Django 2.2, and Django 3.x, because we're no
longer copying large blocks of core Django code and thus should be
much less vulnerable to refactors.
There may be a modest performance downside, in that we now run both
request and response middleware twice when longpolling (once for the
request we discard). We may be able to avoid the expensive part of
it, Zulip's own request/response middleware, with a bit of additional
custom code to save work for requests where we're planning to discard
the response. Profiling will be important to understanding what's
worth doing here.
2020-02-06 22:09:10 +01:00
|
|
|
#
|
|
|
|
|
# Since these views don't use rest_dispatch, they cannot have
|
|
|
|
|
# asynchronous Tornado behavior.
|
2021-02-12 08:20:45 +01:00
|
|
|
path("notify_tornado", notify),
|
|
|
|
|
path("api/v1/events/internal", get_events_internal),
|
2016-06-24 01:02:44 +02:00
|
|
|
]
|
2012-10-15 22:47:52 +02:00
|
|
|
|
2016-07-20 13:33:27 +02:00
|
|
|
# Python Social Auth
|
2020-01-27 12:05:32 +01:00
|
|
|
|
2021-02-12 08:20:45 +01:00
|
|
|
urls += [path("", include("social_django.urls", namespace="social"))]
|
|
|
|
|
urls += [path("saml/metadata.xml", saml_sp_metadata)]
|
2016-07-20 13:33:27 +02:00
|
|
|
|
2022-09-13 17:39:18 +02:00
|
|
|
|
2021-09-10 18:36:56 +02:00
|
|
|
# SCIM2
|
|
|
|
|
|
2022-02-04 19:57:11 +01:00
|
|
|
from django_scim import views as scim_views
|
2021-09-10 18:36:56 +02:00
|
|
|
|
|
|
|
|
urls += [
|
2021-10-16 19:40:27 +02:00
|
|
|
# Everything below here are features that we don't yet support and we want
|
|
|
|
|
# to explicitly mark them to return "Not Implemented" rather than running
|
|
|
|
|
# the django-scim2 code for them.
|
2021-09-10 18:36:56 +02:00
|
|
|
re_path(
|
|
|
|
|
r"^scim/v2/Groups/.search$",
|
2022-02-04 19:57:11 +01:00
|
|
|
scim_views.SCIMView.as_view(implemented=False),
|
2021-09-10 18:36:56 +02:00
|
|
|
),
|
|
|
|
|
re_path(
|
|
|
|
|
r"^scim/v2/Groups(?:/(?P<uuid>[^/]+))?$",
|
2022-02-04 19:57:11 +01:00
|
|
|
scim_views.SCIMView.as_view(implemented=False),
|
2021-10-16 19:40:27 +02:00
|
|
|
),
|
2022-02-04 19:57:11 +01:00
|
|
|
re_path(r"^scim/v2/Me$", scim_views.SCIMView.as_view(implemented=False)),
|
2021-10-16 19:40:27 +02:00
|
|
|
re_path(
|
|
|
|
|
r"^scim/v2/ServiceProviderConfig$",
|
2022-02-04 19:57:11 +01:00
|
|
|
scim_views.SCIMView.as_view(implemented=False),
|
2021-10-16 19:40:27 +02:00
|
|
|
),
|
|
|
|
|
re_path(
|
|
|
|
|
r"^scim/v2/ResourceTypes(?:/(?P<uuid>[^/]+))?$",
|
2022-02-04 19:57:11 +01:00
|
|
|
scim_views.SCIMView.as_view(implemented=False),
|
|
|
|
|
),
|
|
|
|
|
re_path(
|
|
|
|
|
r"^scim/v2/Schemas(?:/(?P<uuid>[^/]+))?$", scim_views.SCIMView.as_view(implemented=False)
|
2021-09-10 18:36:56 +02:00
|
|
|
),
|
2022-02-04 19:57:11 +01:00
|
|
|
re_path(r"^scim/v2/Bulk$", scim_views.SCIMView.as_view(implemented=False)),
|
|
|
|
|
# This registers the remaining SCIM endpoints.
|
2021-09-10 18:36:56 +02:00
|
|
|
path("scim/v2/", include("django_scim.urls", namespace="scim")),
|
|
|
|
|
]
|
|
|
|
|
|
2023-03-24 16:00:46 +01:00
|
|
|
# Front-end Sentry requests tunnel through the server, if enabled
|
|
|
|
|
if settings.SENTRY_FRONTEND_DSN:
|
|
|
|
|
urls += [path("error_tracing", sentry_tunnel)]
|
|
|
|
|
|
2016-11-09 01:45:36 +01:00
|
|
|
# User documentation site
|
2020-09-12 04:18:53 +02:00
|
|
|
help_documentation_view = MarkdownDirectoryView.as_view(
|
2023-01-25 23:08:29 +01:00
|
|
|
template_name="zerver/documentation_main.html",
|
|
|
|
|
path_template=f"{settings.DEPLOY_ROOT}/help/%s.md",
|
|
|
|
|
help_view=True,
|
2020-09-12 04:18:53 +02:00
|
|
|
)
|
|
|
|
|
api_documentation_view = MarkdownDirectoryView.as_view(
|
2023-01-31 12:11:45 +01:00
|
|
|
template_name="zerver/documentation_main.html",
|
|
|
|
|
path_template=f"{settings.DEPLOY_ROOT}/api_docs/%s.md",
|
|
|
|
|
api_doc_view=True,
|
2020-09-12 04:18:53 +02:00
|
|
|
)
|
2021-11-03 21:36:54 +01:00
|
|
|
policy_documentation_view = MarkdownDirectoryView.as_view(
|
|
|
|
|
template_name="zerver/documentation_main.html",
|
|
|
|
|
policies_view=True,
|
|
|
|
|
)
|
2022-07-08 20:20:17 +02:00
|
|
|
|
|
|
|
|
# Redirects due to us having moved help center, API or policy documentation pages:
|
|
|
|
|
for redirect in DOCUMENTATION_REDIRECTS:
|
|
|
|
|
old_url = redirect.old_url.lstrip("/")
|
|
|
|
|
urls += [path(old_url, RedirectView.as_view(url=redirect.new_url, permanent=True))]
|
|
|
|
|
|
2020-09-12 04:18:53 +02:00
|
|
|
urls += [
|
2021-02-12 08:20:45 +01:00
|
|
|
path("help/", help_documentation_view),
|
|
|
|
|
path("help/<path:article>", help_documentation_view),
|
|
|
|
|
path("api/", api_documentation_view),
|
|
|
|
|
path("api/<slug:article>", api_documentation_view),
|
2021-11-03 21:36:54 +01:00
|
|
|
path("policies/", policy_documentation_view),
|
|
|
|
|
path("policies/<slug:article>", policy_documentation_view),
|
2020-09-12 04:18:53 +02:00
|
|
|
]
|
2016-11-09 01:45:36 +01:00
|
|
|
|
apps: Fix redirect from /apps -> https://zulip.com/apps/.
When this code was moved from being in zerver in 21a2fd482eae, it kept
the `if ZILENCER_ENABLED` blocks. Since ZILENCER and CORPORATE are
generally either both on or both off, the if statement became
mostly-unnecessary.
However, because tests cannot easily remove elements from
INSTALLED_APPS and re-determine URL resolution, we switch to checking
`if CORPORATE_ENABLED` as a guard, and leave these in-place.
The other side effect of this is that with e54ded49c44c, most Zulip
deployments started to 404 requests for `/apps` instead of redirecting
them to `https://zulip.com/apps/` since they no longer had any path
configured for `/apps`. Unfortunately, this URL is in widespread use
in the app (e.g. in links from the Welcome Bot), so we should ensure
that it does successfully redirect.
Add the `/apps` path to `zerver`, but only if not CORPORATE_ENABLED,
so the URLs do not overlap.
2022-12-16 15:17:00 +01:00
|
|
|
if not settings.CORPORATE_ENABLED:
|
|
|
|
|
# This conditional behavior cannot be tested directly, since
|
|
|
|
|
# urls.py is not readily reloaded in Django tests. See the block
|
|
|
|
|
# comment inside apps_view for details.
|
|
|
|
|
urls += [
|
|
|
|
|
path("apps/", RedirectView.as_view(url="https://zulip.com/apps/", permanent=True)),
|
|
|
|
|
]
|
|
|
|
|
|
2020-10-23 02:43:28 +02:00
|
|
|
# Two-factor URLs
|
2017-07-12 09:36:51 +02:00
|
|
|
if settings.TWO_FACTOR_AUTHENTICATION_ENABLED:
|
2021-02-12 08:20:45 +01:00
|
|
|
urls += [path("", include(tf_urls)), path("", include(tf_twilio_urls))]
|
2017-07-12 09:36:51 +02:00
|
|
|
|
2015-08-21 08:55:12 +02:00
|
|
|
if settings.DEVELOPMENT:
|
2016-06-25 03:44:32 +02:00
|
|
|
urls += dev_urls.urls
|
2016-06-25 19:04:36 +02:00
|
|
|
i18n_urls += dev_urls.i18n_urls
|
2021-04-23 11:01:20 +02:00
|
|
|
v1_api_mobile_patterns += dev_urls.v1_api_mobile_patterns
|
|
|
|
|
|
|
|
|
|
urls += [
|
|
|
|
|
path("api/v1/", include(v1_api_mobile_patterns)),
|
|
|
|
|
]
|
2016-06-25 00:33:07 +02:00
|
|
|
|
2020-10-23 02:43:28 +02:00
|
|
|
# The sequence is important; if i18n URLs don't come first then
|
|
|
|
|
# reverse URL mapping points to i18n URLs which causes the frontend
|
2016-05-19 17:33:30 +02:00
|
|
|
# tests to fail
|
2016-06-25 00:38:41 +02:00
|
|
|
urlpatterns = i18n_patterns(*i18n_urls) + urls + legacy_urls
|
