From 3ec4e28af692ec29d6c337517aab56fc247c8513 Mon Sep 17 00:00:00 2001
From: Tobias Diekershoff <tobias.diekershoff@gmx.net>
Date: Tue, 3 Apr 2018 06:55:25 +0200
Subject: [PATCH] updated the privacy statement text and added some headers to
 the functions

---
 mod/tos.php      | 35 ++++++++++++++++++++-------
 util/messages.po | 62 ++++++++++++++++++++++++------------------------
 2 files changed, 58 insertions(+), 39 deletions(-)

diff --git a/mod/tos.php b/mod/tos.php
index 4ce8a8f3f..70fd87aaa 100644
--- a/mod/tos.php
+++ b/mod/tos.php
@@ -1,37 +1,56 @@
 <?php
 /**
  * @file mod/tos.php
+ *
+ * This module displays the Terms of Service for a node, if the admin
+ * wants them to be displayed.
  */
 use Friendica\App;
-use Friendica\Core\Addon;
 use Friendica\Core\Config;
 use Friendica\Core\L10n;
 use Friendica\Core\System;
 use Friendica\Module\Login;
 use Friendica\Content\Text\BBCode;
 
+/**
+ * @brief initialize the TOS module.
+ *
+ * If this is a single user instance, we expect the user to know their
+ * dealings with their own node so a TOS is not necessary.
+ *
+ * @param App $a
+ * */
 function tos_init(App $a) {
 
-	$ret = [];
-	Addon::callHooks('tos_init',$ret);
-
 	if (strlen(Config::get('system','singleuser'))) {
 		goaway(System::baseUrl()."/profile/" . Config::get('system','singleuser'));
 	}
 
 }
 
+/**
+ * @brief generate the content of the /tos page
+ *
+ * The content of the /tos page is generated from two parts.
+ * (1) a free form part the admin of the node can set in the admin panel
+ * (2) an optional privacy statement that gives some transparency about
+ *     what information are needed by the software to provide the service.
+ *     This privacy statement has fixed text, so it can be translated easily.
+ *
+ * @param App $a
+ * @return string
+ */
 function tos_content(App $a) {
 	$tpl = get_markup_template('tos.tpl');
 	if (Config::get('system', 'tosdisplay'))
 	{
 	return replace_macros($tpl, [
-		'$title' => L10n::t('Terms of Service'),
+		'$title' => L10n::t("Terms of Service"),
 		'$tostext' => BBCode::convert(Config::get('system', 'tostext')),
 		'$displayprivstatement' => Config::get('system', 'tosprivstatement'),
-		'$privstatementtitle' => L10n::t('Privacy Statement'),
-		'$privoperate' => L10n::t('At the time of registration, and for providing communications between the user account and their contacts, the user has to provide a display name (pen name), a nickname and a working email address. The names will be accessible on the profile page of the account by any visitor of the page even if other profile details are not displayed. The email address will only be used to send the user notifications about interactions, but wont be visibly displayed. The listing of an account in the nodes user directory or the global user directory is optional and can be controlled in the user settings, it is not necessary for communication.'),
-		'$privdelete' => L10n::t('At any point in time a logged in user can export their account data from the <a href="%1$s/settings/uexport">account settings</a>. If the user wants to delete their account they can do so at <a href="%1$s">%1$s</a>. The deletion of the account will be permanent.', System::baseurl().'/removeme')
+		'$privstatementtitle' => L10n::t("Privacy Statement"),
+		'$privoperate' => L10n::t('At the time of registration, and for providing communications between the user account and their contacts, the user has to provide a display name (pen name), an username (nickname) and a working email address. The names will be accessible on the profile page of the account by any visitor of the page, even if other profile details are not displayed. The email address will only be used to send the user notifications about interactions, but wont be visibly displayed. The listing of an account in the node\'s user directory or the global user directory is optional and can be controlled in the user settings, it is not necessary for communication.'),
+		'$privdelete' => L10n::t('At any point in time a logged in user can export their account data from the <a href="%1$s/settings/uexport">account settings</a>. If the user wants to delete their account they can do so at <a href="%1$s/removeme">%1$s/removeme</a>. The deletion of the account will be permanent.', System::baseurl())
 	]);
 	} else {
 		return;
diff --git a/util/messages.po b/util/messages.po
index ac457d982..40829b007 100644
--- a/util/messages.po
+++ b/util/messages.po
@@ -8,7 +8,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: \n"
 "Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2018-04-02 18:46+0200\n"
+"POT-Creation-Date: 2018-04-03 06:50+0200\n"
 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language-Team: LANGUAGE <LL@li.org>\n"
@@ -5701,36 +5701,6 @@ msgstr ""
 msgid "Create New Profile"
 msgstr ""
 
-#: mod/tos.php:29 mod/register.php:288 mod/admin.php:188 mod/admin.php:302
-msgid "Terms of Service"
-msgstr ""
-
-#: mod/tos.php:32
-msgid "Privacy Statement"
-msgstr ""
-
-#: mod/tos.php:33
-msgid ""
-"At the time of registration, and for providing communications between the "
-"user account and their contacts, the user has to provide a display name (pen "
-"name), a nickname and a working email address. The names will be accessible "
-"on the profile page of the account by any visitor of the page even if other "
-"profile details are not displayed. The email address will only be used to "
-"send the user notifications about interactions, but wont be visibly "
-"displayed. The listing of an account in the nodes user directory or the "
-"global user directory is optional and can be controlled in the user "
-"settings, it is not necessary for communication."
-msgstr ""
-
-#: mod/tos.php:34
-#, php-format
-msgid ""
-"At any point in time a logged in user can export their account data from the "
-"<a href=\"%1$s/settings/uexport\">account settings</a>. If the user wants to "
-"delete their account they can do so at <a href=\"%1$s\">%1$s</a>. The "
-"deletion of the account will be permanent."
-msgstr ""
-
 #: mod/register.php:99
 msgid ""
 "Registration successful. Please check your email for further instructions."
@@ -5828,6 +5798,10 @@ msgstr ""
 msgid "Import your profile to this friendica instance"
 msgstr ""
 
+#: mod/register.php:288 mod/admin.php:188 mod/admin.php:302 mod/tos.php:48
+msgid "Terms of Service"
+msgstr ""
+
 #: mod/friendica.php:77
 msgid "This is Friendica, version"
 msgstr ""
@@ -7551,6 +7525,32 @@ msgstr ""
 msgid "Manage Additional Features"
 msgstr ""
 
+#: mod/tos.php:51
+msgid "Privacy Statement"
+msgstr ""
+
+#: mod/tos.php:52
+msgid ""
+"At the time of registration, and for providing communications between the "
+"user account and their contacts, the user has to provide a display name (pen "
+"name), an username (nickname) and a working email address. The names will be "
+"accessible on the profile page of the account by any visitor of the page, "
+"even if other profile details are not displayed. The email address will only "
+"be used to send the user notifications about interactions, but wont be "
+"visibly displayed. The listing of an account in the node's user directory or "
+"the global user directory is optional and can be controlled in the user "
+"settings, it is not necessary for communication."
+msgstr ""
+
+#: mod/tos.php:53
+#, php-format
+msgid ""
+"At any point in time a logged in user can export their account data from the "
+"<a href=\"%1$s/settings/uexport\">account settings</a>. If the user wants to "
+"delete their account they can do so at <a href=\"%1$s/removeme\">%1$s/"
+"removeme</a>. The deletion of the account will be permanent."
+msgstr ""
+
 #: src/Core/UserImport.php:104
 msgid "Error decoding account file"
 msgstr ""