ltb-project#127: Added feature to enable and disable comment. Added d…

…ocumentation for the feature.
Worteks · Jul 22, 2024 · d765861 · d765861
1 parent e3b2e42
commit d765861
Show file tree

Hide file tree

Showing 8 changed files with 60 additions and 16 deletions.
diff --git a/conf/config.inc.php b/conf/config.inc.php
@@ -104,7 +104,9 @@
 $resetpassword_reset_default = true;
 $show_lockstatus = true;
 $use_unlockaccount = true;
+$use_unlockcomment = false;
 $use_lockaccount = true;
+$use_lockcomment = false;
 $show_expirestatus = true;
 $use_searchlocked = true;
 $use_searchexpired = true;

diff --git a/docs/images/image.png b/docs/images/image.png
diff --git a/docs/images/ltb-insert-comment.jpg b/docs/images/ltb-insert-comment.jpg
diff --git a/docs/lockaccount.rst b/docs/lockaccount.rst
@@ -33,3 +33,17 @@ To enable this feature:
 .. code-block:: php
 
     $use_unlockaccount = true;
+
+Insert comment
+--------------
+
+A feature to enable comments when locking and unlocking user accounts can be enabled.
+
+.. image:: images/ltb-insert-comment.jpg
+
+To enable this feature:
+
+.. code-block:: php
+
+    $use_lockcomment = true;
+    $use_unlockcomment = true;
diff --git a/htdocs/index.php b/htdocs/index.php
@@ -67,7 +67,9 @@
 $smarty->assign('resetpassword_reset_default',$resetpassword_reset_default);
 $smarty->assign('show_lockstatus',$show_lockstatus);
 $smarty->assign('use_unlockaccount',$use_unlockaccount);
+$smarty->assign('use_unlockcomment',$use_unlockcomment);
 $smarty->assign('use_lockaccount',$use_lockaccount);
+$smarty->assign('use_lockcomment',$use_lockcomment);
 $smarty->assign('show_expirestatus',$show_expirestatus);
 $smarty->assign('display_password_expiration_date',$display_password_expiration_date);
 $smarty->assign('use_searchlocked',$use_searchlocked);

diff --git a/htdocs/lockaccount.php b/htdocs/lockaccount.php
@@ -6,7 +6,7 @@
 $result = "";
 $dn = "";
 $password = "";
-$comment = $_POST["comment"];
+$comment = "";
 
 if (isset($_POST["dn"]) and $_POST["dn"]) {
     $dn = $_POST["dn"];
@@ -73,6 +73,11 @@
     }
 }
 
+
+if (isset($_POST["comment"])) {
+    $comment = $_POST["comment"];
+}
+
 if ($audit_log_file) {
     auditlog($audit_log_file, $dn, $audit_admin, "lockaccount", $result, $comment);
 }

diff --git a/htdocs/unlockaccount.php b/htdocs/unlockaccount.php
@@ -7,7 +7,7 @@
 $dn = "";
 $password = "";
 $returnto = "display";
-$comment = $_POST["comment"];
+$comment = "";
 
 if (isset($_POST["dn"]) and $_POST["dn"]) {
     $dn = $_POST["dn"];
@@ -43,6 +43,10 @@
     }
 }
 
+if (isset($_POST["comment"])) {
+    $comment = $_POST["comment"];
+}
+
 if ($audit_log_file) {
     auditlog($audit_log_file, $dn, $audit_admin, "unlockaccount", $result, $comment);
 }

diff --git a/templates/display.tpl b/templates/display.tpl
@@ -211,13 +211,22 @@
                 {if $unlockaccountresult eq 'ldaperror'}
                 <div class="alert alert-danger"><i class="fa fa-fw fa-exclamation-triangle"></i> {$msg_accountnotunlocked}</div>
                 {/if}
-                <button type="button" class="btn btn-primary" data-bs-toggle="modal" data-bs-target="#commentModal">
-                    <i class="fa fa-fw fa-unlock"></i> {$msg_unlockaccount}
-                </button>
-                <div>
-                    {include 'comment.tpl' method=unlock page=unlockaccount}
-                </div>
-                 {/if}
+                {if $use_unlockcomment}
+                    <button type="button" class="btn btn-primary" data-bs-toggle="modal" data-bs-target="#commentModal">
+                        <i class="fa fa-fw fa-unlock"></i> {$msg_unlockaccount}
+                    </button>
+                    <div>
+                        {include 'comment.tpl' method=unlock page=unlockaccount}
+                    </div>
+                {else}
+                    <form id="unlockaccount" method="post" action="index.php?page=unlockaccount">
+                    <input type="hidden" name="dn" value="{$dn}" />
+                        <button type="submit" class="btn btn-success">
+                            <i class="fa fa-fw fa-unlock"></i> {$msg_unlockaccount}
+                        </button>
+                    </form>
+                {/if}
+                {/if}
             </div>
         </div>
         {/if}
@@ -236,13 +245,21 @@
                 {if $lockaccountresult eq 'ldaperror'}
                     <div class="alert alert-danger"><i class="fa fa-fw fa-exclamation-triangle"></i> {$msg_accountnotlocked}</div>
                 {/if}
-                <input type="hidden" name="dn" value="{$dn}" />
-                <button type="button" class="btn btn-primary" data-bs-toggle="modal" data-bs-target="#commentModal">
-                    <i class="fa fa-fw fa-lock"></i> {$msg_lockaccount}
-                </button>
-                <div>
-                    {include 'comment.tpl' method=lock page=lockaccount}
-                </div>
+                {if $use_lockcomment}
+                    <button type="button" class="btn btn-primary" data-bs-toggle="modal" data-bs-target="#commentModal">
+                        <i class="fa fa-fw fa-lock"></i> {$msg_lockaccount}
+                    </button>
+                    <div>
+                        {include 'comment.tpl' method=lock page=lockaccount}
+                    </div>
+                {else}
+                    <form id="lockaccount" method="post" action="index.php?page=lockaccount">
+                    <input type="hidden" name="dn" value="{$dn}" />
+                        <button type="submit" class="btn btn-success">
+                            <i class="fa fa-fw fa-lock"></i> {$msg_lockaccount}
+                        </button>
+                    </form>
+                {/if}
             </div>
             {/if}
         </div>