Merge remote-tracking branch 'remotes/origin/feature/extend-watermark-placeholders' into develop

Author: LinneyS

CHANGELOG.md

@@ -8,6 +8,7 @@
 - replaced general save success message with dedicated messages for each settings section
 - show warning popup when jwt secret is empty and success message otherwise
 - download all document pages when converting to image types with Download As method
+- extend supported watermark placeholders
 
 ## Added
 - plugin description and useful links in admin settings

lib/Controller/EditorApiController.php

@@ -603,7 +603,7 @@ public function config($fileId, $filePath = null, $shareToken = null, $directTok
 
         $params = $this->setCustomization($params);
 
-        $params = $this->setWatermark($params, !empty($shareToken), $userId, $file);
+        $params = $this->setWatermark($params, !empty($shareToken), $user, $file);
 
         if ($this->config->useDemo()) {
             $params["editorConfig"]["tenant"] = $this->config->getSystemValue("instanceid", true);
@@ -840,12 +840,12 @@ private function setCustomization($params) {
      *
      * @param array params - file parameters
      * @param bool isPublic - with access token
-     * @param string userId - user identifier
+     * @param IUser $user - current user
      * @param string file - file
      *
      * @return array
      */
-    private function setWatermark($params, $isPublic, $userId, $file) {
+    private function setWatermark($params, $isPublic, $user, $file) {
         $watermarkTemplate = $this->getWatermarkText(
             $isPublic,
             $userId,
@@ -855,13 +855,22 @@ private function setWatermark($params, $isPublic, $userId, $file) {
         );
 
         if ($watermarkTemplate !== false) {
-            if (empty($userId)) {
+            if (empty($user)) {
+                $userId = $this->trans->t('Anonymous');
+                $userDisplayName = $this->trans->t('Anonymous');
+                $email = $this->trans->t('Anonymous');
                 $timezone = $this->timezoneService->getDefaultTimezone();
             } else {
+                $userId = $user->getUID();
+                $userDisplayName = $user->getDisplayName();
+                $email = $user->getEMailAddress();
                 $timezone = $this->timezoneService->getUserTimezone($userId) ?? $this->timezoneService->getDefaultTimezone();
             }
+
             $replacements = [
-                "userId" => isset($userId) ? $userId : $this->trans->t('Anonymous'),
+                "userId" => $userId,
+                "userDisplayName" => $userDisplayName,
+                "email" => $email,
                 "date" => (new \DateTime("now", new \DateTimeZone($timezone)))->format("Y-m-d H:i:s"),
                 "themingName" => \OC::$server->getThemingDefaults()->getName()
             ];

templates/settings.php

@@ -372,7 +372,7 @@
         <br />
         <p><?php p($l->t("Watermark text")) ?></p>
         <br />
-        <p class="settings-hint"><?php p($l->t("Supported placeholders")) ?>: {userId}, {date}, {themingName}</p>
+        <p class="settings-hint"><?php p($l->t("Supported placeholders")) ?>: {userId}, {userDisplayName}, {email}, {date}, {themingName}</p>
         <p><input id="onlyofficeWatermark_text" value="<?php p($_["watermark"]["text"]) ?>" placeholder="<?php p($l->t("DO NOT SHARE THIS")) ?> {userId} {date}" type="text"></p>
 
         <br />