From 77e649f747dd3a0771e3f4798718ac3226e38ee5 Mon Sep 17 00:00:00 2001
From: Jacob Kiers <code@kiers.eu>
Date: Sat, 12 Mar 2022 01:48:56 +0100
Subject: [PATCH] Add feature to also redact custom link text

It is possible that a private person is linked to in a tiddler with the
syntax `[[Jane|MsJaneDoe]]`.

Up to now, the text of the link was not redacted, which could lead to
unintentional privacy leaks.

Therefore, a new parameter `replace_text` is introduced for the
`replace_private_people` builder.

When that is set to True, then the link text is also replaced with the
initials.

Signed-off-by: Jacob Kiers <code@kiers.eu>
---
 tzk/builders.py | 28 ++++++++++++++++++++++++++--
 1 file changed, 26 insertions(+), 2 deletions(-)

diff --git a/tzk/builders.py b/tzk/builders.py
index 8d05b96..93b30f5 100644
--- a/tzk/builders.py
+++ b/tzk/builders.py
@@ -360,7 +360,7 @@ def _private_people_replacement_table(
 
 
 @tzk_builder
-def replace_private_people(initialer: Callable[[str], str] = None) -> None:
+def replace_private_people(initialer: Callable[[str], str] = None, replace_link_text = False) -> None:
     """
     Replace the names of people who are not marked Public with their initials.
 
@@ -384,6 +384,20 @@ def replace_private_people(initialer: Callable[[str], str] = None) -> None:
                       that takes one string argument
                       (a tiddler filename without the full path, e.g., ``MsJaneDoe.tid``)
                       and returns a string to be considered the "initials" of that person.
+
+    :param replace_link_text: If you have links in the form
+                              ``So then [[John said|MrJohnDoe]] something about this``,
+                              then enabling this option ensures that the link is fully
+                              replaced with
+                              ``So then [[J.D.|PrivatePerson]] something about this``.
+                              This means that when using this feature, having the
+                              link text also be meaningful after redaction is important.
+
+    .. warning ::
+        Using this link replacement feature does not redact everything, just the link
+        (and the link text with `replace_link_text` enabled). So *do not* rely on it
+        for redacting everything. Making a tiddler public still needs consideration and
+        tooling is there to help, not to replace your own judgment.
     """
     assert 'public_wiki_folder' in build_state
 
@@ -401,7 +415,17 @@ def replace_private_people(initialer: Callable[[str], str] = None) -> None:
                     if '|' + replace_person + ']]' in lines[i]:
                         # link with the person as the target only;
                         # beware that you might have put something private in the text
-                        lines[i] = lines[i].replace(replace_person, 'PrivatePerson')
+                        if replace_link_text:
+                            # with this option, the initials are also
+                            # put in the text, solving the warning before
+                            end = lines[i].find('|' + replace_person + ']]')
+                            start = lines[i].rfind('[[', 0, end) + 2
+                            search = f"[[{lines[i][start:end]}|{replace_person}]]"
+                            replace = f"[[{replace_initials}|PrivatePerson]]"
+
+                            lines[i] = lines[i].replace(search, replace)
+                        else:
+                            lines[i] = lines[i].replace(replace_person, 'PrivatePerson')
                     elif '[[' + replace_person + ']]' in lines[i]:
                         # link with the person as the target and text
                         lines[i] = lines[i].replace(