zulip/zerver/lib/markdown
Zixuan James Li 268f858f39 linkifier: Support URL templates for linkifiers.
This swaps out url_format_string from all of our APIs and replaces it
with url_template. Note that the documentation changes in the following
commits  will be squashed with this commit.

We change the "url_format" key to "url_template" for the
realm_linkifiers events in event_schema, along with updating
LinkifierDict. "url_template" is the name chosen to normalize
mixed usages of "url_format_string" and "url_format" throughout
the backend.

The markdown processor is updated to stop handling the format string
interpolation and delegate the task template expansion to the uri_template
library instead.

This change affects many test cases. We mostly just replace "%(name)s"
with "{name}", "url_format_string" with "url_template" to make sure that
they still pass. There are some test cases dedicated for testing "%"
escaping, which aren't relevant anymore and are subject to removal.
But for now we keep most of them as-is, and make sure that "%" is always
escaped since we do not use it for variable substitution any more.

Since url_format_string is not populated anymore, a migration is created
to remove this field entirely, and make url_template non-nullable since
we will always populate it. Note that it is possible to have
url_template being null after migration 0422 and before 0424, but
in practice, url_template will not be None after backfilling and the
backend now is always setting url_template.

With the removal of url_format_string, RealmFilter model will now be cleaned
with URL template checks, and the old checks for escapes are removed.

We also modified RealmFilter.clean to skip the validation when the
url_template is invalid. This avoids raising mulitple ValidationError's
when calling full_clean on a linkifier. But we might eventually want to
have a more centric approach to data validation instead of having
the same validation in both the clean method and the validator.

Fixes #23124.

Signed-off-by: Zixuan James Li <p359101898@gmail.com>
2023-04-19 12:20:49 -07:00
..
__init__.py linkifier: Support URL templates for linkifiers. 2023-04-19 12:20:49 -07:00
api_arguments_table_generator.py black: Reformat with Black 23. 2023-02-02 10:40:13 -08:00
api_return_values_table_generator.py response: Implement ignored parameters with MutableJsonResponse class. 2023-03-06 10:33:13 -08:00
fenced_code.py markdown: Fix use of pure_markdown for non-pure markdown rendering. 2023-03-17 08:46:25 -07:00
help_emoticon_translations_table.py markdown: Rename preprocessor_priorities module to priorities. 2022-06-26 17:36:31 -07:00
help_relative_links.py web: Save a 301 redirect from /billing to /billing/. 2023-03-24 14:51:01 -07:00
help_settings_links.py help: Improve relative settings links for documentation on bots. 2023-02-06 15:06:15 -08:00
include.py ruff: Fix N818 exception name should be named with an Error suffix. 2022-11-17 16:52:00 -08:00
nested_code_blocks.py ruff: Fix SIM102 nested if statements. 2023-01-23 11:18:36 -08:00
priorities.py markdown: Rewrite /static/ images to use staticfiles_storage.url. 2023-02-14 17:17:06 -05:00
static.py markdown: Rewrite /static/ images to use staticfiles_storage.url. 2023-02-14 17:17:06 -05:00
tabbed_sections.py help center: Document SAML configuration steps with Auth0. 2023-03-30 09:11:55 -07:00
testing_mocks.py python: Reformat with Black, except quotes. 2021-02-12 13:11:19 -08:00