From b369a58e43400660a575bb2b1a2413141d829a00 Mon Sep 17 00:00:00 2001 From: Megan Date: Wed, 11 Mar 2009 17:01:13 +0200 Subject: [PATCH] Updated Electronic Signature functionality. Moved it into a plugin. In Progress. --- config/dmsDefaults.php | 8 ++++---- lib/security/Esignature.inc.php | 221 ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- lib/templating/kt3template.inc.php | 4 ++-- plugins/ktcore/KTPermissions.php | 6 ++++-- plugins/ktcore/folder/Permissions.php | 3 ++- plugins/ktcore/folder/Rename.php | 3 ++- plugins/ktstandard/KTElectronicSignatures.php | 192 ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ resources/css/kt-framing.css | 26 +++++++++----------------- resources/js/signature.js | 130 ---------------------------------------------------------------------------------------------------------------------------------- sql/mysql/install/data.sql | 6 ++---- sql/mysql/upgrade/3.5.5/config_signatures.sql | 5 ----- templates/ktstandard/signatures/signature_form.smarty | 31 ------------------------------- 12 files changed, 25 insertions(+), 610 deletions(-) delete mode 100644 lib/security/Esignature.inc.php delete mode 100644 plugins/ktstandard/KTElectronicSignatures.php delete mode 100644 resources/js/signature.js delete mode 100644 sql/mysql/upgrade/3.5.5/config_signatures.sql delete mode 100644 templates/ktstandard/signatures/signature_form.smarty diff --git a/config/dmsDefaults.php b/config/dmsDefaults.php index 2cf656d..6480fff 100644 --- a/config/dmsDefaults.php +++ b/config/dmsDefaults.php @@ -623,6 +623,9 @@ require_once(KT_LIB_DIR . '/session/control.inc'); require_once(KT_LIB_DIR . '/plugins/pluginutil.inc.php'); +require_once(KT_LIB_DIR . '/templating/kt3template.inc.php'); +$GLOBALS['main'] =new KTPage(); + if ($checkup !== true) { // Replace function later /* ** Get the page being loaded and load the plugins specific to the page ** */ @@ -652,7 +655,4 @@ if (!extension_loaded('mbstring')) } -require_once(KT_LIB_DIR . '/templating/kt3template.inc.php'); -$GLOBALS['main'] =new KTPage(); - -?> +?> \ No newline at end of file diff --git a/lib/security/Esignature.inc.php b/lib/security/Esignature.inc.php deleted file mode 100644 index bd5e882..0000000 --- a/lib/security/Esignature.inc.php +++ /dev/null @@ -1,221 +0,0 @@ -. - * - * You can contact KnowledgeTree Inc., PO Box 7775 #87847, San Francisco, - * California 94120-7775, or email info@knowledgetree.com. - * - * The interactive user interfaces in modified source and object code versions - * of this program must display Appropriate Legal Notices, as required under - * Section 5 of the GNU General Public License version 3. - * - * In accordance with Section 7(b) of the GNU General Public License version 3, - * these Appropriate Legal Notices must retain the display of the "Powered by - * KnowledgeTree" logo and retain the original copyright notice. If the display of the - * logo is not reasonably feasible for technical reasons, the Appropriate Legal Notices - * must display the words "Powered by KnowledgeTree" and retain the original - * copyright notice. - * Contributor( s): ______________________________________ - * - */ - -/** - * This class defines the electronic signatures - * - * @author KnowledgeTree Team - * @package Electronic Signatures - * @version Version 0.1 - */ -class ESignature -{ - /** - * Check whether the electronic signature is enabled - * - * @access private - * @var bool - */ - private $enabled; - - /** - * The number of failed logins on the current action - * - * @access private - * @var integer - */ - private $attempts; - - /** - * Determines whether the user has been locked out of performing write actions. - * This lock will be reset upon logging out of the system. - * - * @access private - * @var bool - */ - private $lock; - - /** - * Contains the error message if the authentication fails - * - * @access private - * @var string - */ - private $error; - - /** - * The object associated with the action - folder_id | Document - * - * @access private - * @var folder_id | Document The Document object or the folder id - */ - private $object = null; - - /** - * Creates the ESignature object - * - * @author KnowledgeTree Team - * @access public - */ - public function __construct() - { - $config = KTConfig::getSingleton(); - $this->enabled = $config->get('e_signatures/enableESignatures', false); - - $this->attempts = isset($_SESSION['esignature_attempts']) ? $_SESSION['esignature_attempts'] : 0; - $this->lock = (isset($_SESSION['esignature_lock']) && $_SESSION['esignature_lock'] == 'true') ? true : false; - } - - public function isEnabled() - { - if($this->enabled){ - return true; - } - return false; - } - - public function isLocked() - { - return $this->lock; - } - - public function getLockMsg() - { - return _kt('System locked. You have exceeded the number of allowed authentication attempts and will not be allowed to perform any write actions during this session.'); - } - - public function getError(){ - return $this->error; - } - - public function setObject($object) - { - $this->object = $object; - } - - public function sign($username, $password, $comment, $action, $type = 'system', $details = null) - { - if(!$this->enabled){ - return true; - } - - if($this->lock){ - $this->error = $this->getLockMsg(); - return false; - } - - switch ($type){ - case 'document': - $comment = _kt('Document').': '.$details.' | '.$comment; - break; - - case 'folder': - $comment = _kt('Folder').': '.$details.' | '.$comment; - break; - - case 'system': - break; - } - - $this->error = _kt('Authentication failed. Please check your username and password and try again.'); - - if(!$this->authenticate($username, $password)){ - // failed attempt - increase count, if count = 3, log and lock - $this->attempts++; - - if($this->attempts >= 3){ - $this->lock = true; - $_SESSION['esignature_lock'] = 'true'; - - $comment = _kt('Electronic Signature - Failed Authentication: ') . $comment; - $this->logTransaction($action, $comment, $type, $details); - - $this->error = $this->getLockMsg(); - } - $_SESSION['esignature_attempts'] = $this->attempts; - - return false; - } - - // set the number of attempts to 0 - $this->attempts = 0; - $_SESSION['esignature_attempts'] = 0; - $this->error = ''; - - // log successful transaction - $comment = _kt('Electronic Signature: ') . $comment; - $this->logTransaction($action, $comment, $type, $details); - return true; - } - - private function logTransaction($action, $comment) - { - $date = date('Y-m-d H:i:s'); - - require_once(KT_LIB_DIR . '/users/userhistory.inc.php'); - $params = array( - 'userid' => $_SESSION['userID'], - 'datetime' => $date, - 'actionnamespace' => $action, - 'comments' => $comment, - 'sessionid' => $_SESSION['sessionID'], - ); - KTUserHistory::createFromArray($params); - } - - private function authenticate($username, $password) - { - // Get the user object - $oUser = User::getByUsername($username); - if(PEAR::isError($oUser) || $oUser == false){ - return false; - } - - // check user is the same as the currently logged in user - if($oUser->iId != $_SESSION['userID']){ - $this->error = _kt('Authentication failed. The username does not match the currently logged in user.'); - return false; - } - - // authenticate - return KTAuthenticationUtil::checkPassword($oUser, $password); - } - -} - -?> \ No newline at end of file diff --git a/lib/templating/kt3template.inc.php b/lib/templating/kt3template.inc.php index 27db665..2fe364b 100644 --- a/lib/templating/kt3template.inc.php +++ b/lib/templating/kt3template.inc.php @@ -133,7 +133,6 @@ class KTPage { $aJS[] = 'thirdpartyjs/extjs/adapter/ext/ext-base.js'; $aJS[] = 'thirdpartyjs/extjs/ext-all.js'; $aJS[] = 'resources/js/search2widget.js'; - $aJS[] = 'resources/js/signature.js'; $this->requireJSResources($aJS); @@ -162,9 +161,10 @@ class KTPage { global $default; if($default->enableESignatures){ + $sUrl = KTPluginUtil::getPluginPath('electronic.signatures.plugin', true); $heading = _kt('You are attempting to access DMS Administration'); $this->menu['administration']['url'] = '#'; - $this->menu['administration']['onclick'] = "javascript: showSignatureForm('{$heading}', 'dms.administration.access', 'system', '{$sBaseUrl}/admin.php', 'redirect');"; + $this->menu['administration']['onclick'] = "javascript: showSignatureForm('{$sUrl}', '{$heading}', 'dms.administration.accessing_administration', 'system', '{$sBaseUrl}/admin.php', 'redirect');"; }else{ $this->menu['administration']['url'] = $sBaseUrl.'/admin.php'; } diff --git a/plugins/ktcore/KTPermissions.php b/plugins/ktcore/KTPermissions.php index 6ca4138..015a782 100644 --- a/plugins/ktcore/KTPermissions.php +++ b/plugins/ktcore/KTPermissions.php @@ -582,9 +582,10 @@ class KTRoleAllocationPlugin extends KTFolderAction { // Include the electronic signature on the permissions action global $default; if($default->enableESignatures){ + $sUrl = KTPluginUtil::getPluginPath('electronic.signatures.plugin', true); $heading = _kt('You are attempting to modify roles'); $input['type'] = 'button'; - $input['onclick'] = "javascript: showSignatureForm('{$heading}', 'ktcore.transactions.roles_modify_users', 'folder', 'userroleform', 'submit', {$iFolderId});"; + $input['onclick'] = "javascript: showSignatureForm('{$sUrl}', '{$heading}', 'ktcore.transactions.roles_modify_users', 'folder', 'userroleform', 'submit', {$iFolderId});"; }else{ $input['type'] = 'submit'; $input['onclick'] = ''; @@ -646,9 +647,10 @@ class KTRoleAllocationPlugin extends KTFolderAction { // Include the electronic signature on the permissions action global $default; if($default->enableESignatures){ + $sUrl = KTPluginUtil::getPluginPath('electronic.signatures.plugin', true); $heading = _kt('You are attempting to modify roles'); $input['type'] = 'button'; - $input['onclick'] = "javascript: showSignatureForm('{$heading}', 'ktcore.transactions.roles_modify_groups', 'folder', 'grouproleform', 'submit', {$iFolderId});"; + $input['onclick'] = "javascript: showSignatureForm('{$sUrl}', '{$heading}', 'ktcore.transactions.roles_modify_groups', 'folder', 'grouproleform', 'submit', {$iFolderId});"; }else{ $input['type'] = 'submit'; $input['onclick'] = ''; diff --git a/plugins/ktcore/folder/Permissions.php b/plugins/ktcore/folder/Permissions.php index 66b693b..575e229 100644 --- a/plugins/ktcore/folder/Permissions.php +++ b/plugins/ktcore/folder/Permissions.php @@ -319,9 +319,10 @@ class KTFolderPermissionsAction extends KTFolderAction { global $default; if($default->enableESignatures){ + $sUrl = KTPluginUtil::getPluginPath('electronic.signatures.plugin', true); $heading = _kt('You are attempting to modify permissions'); $input['type'] = 'button'; - $input['onclick'] = "javascript: showSignatureForm('{$heading}', 'ktcore.transactions.permissions_change', 'folder', 'update_permissions_form', 'submit', {$iFolderId});"; + $input['onclick'] = "javascript: showSignatureForm('{$sUrl}', '{$heading}', 'ktcore.transactions.permissions_change', 'folder', 'update_permissions_form', 'submit', {$iFolderId});"; }else{ $input['type'] = 'submit'; $input['onclick'] = ''; diff --git a/plugins/ktcore/folder/Rename.php b/plugins/ktcore/folder/Rename.php index 6ecc0ac..46f782d 100644 --- a/plugins/ktcore/folder/Rename.php +++ b/plugins/ktcore/folder/Rename.php @@ -66,8 +66,9 @@ class KTFolderRenameAction extends KTFolderAction { global $default; if($default->enableESignatures){ + $sUrl = KTPluginUtil::getPluginPath('electronic.signatures.plugin', true); $heading = _kt('You are attempting to rename a folder'); - $input['onclick'] = "javascript: showSignatureForm('{$heading}', 'ktcore.transactions.rename', 'folder', 'rename_folder_form', 'submit', {$this->oFolder->getId()});"; + $input['onclick'] = "javascript: showSignatureForm('{$sUrl}', '{$heading}', 'ktcore.transactions.rename', 'folder', 'rename_folder_form', 'submit', {$this->oFolder->getId()});"; $input['type'] = 'button'; }else{ $input['onclick'] = ''; diff --git a/plugins/ktstandard/KTElectronicSignatures.php b/plugins/ktstandard/KTElectronicSignatures.php deleted file mode 100644 index f12b558..0000000 --- a/plugins/ktstandard/KTElectronicSignatures.php +++ /dev/null @@ -1,192 +0,0 @@ -. - * - * You can contact KnowledgeTree Inc., PO Box 7775 #87847, San Francisco, - * California 94120-7775, or email info@knowledgetree.com. - * - * The interactive user interfaces in modified source and object code versions - * of this program must display Appropriate Legal Notices, as required under - * Section 5 of the GNU General Public License version 3. - * - * In accordance with Section 7(b) of the GNU General Public License version 3, - * these Appropriate Legal Notices must retain the display of the "Powered by - * KnowledgeTree" logo and retain the original copyright notice. If the display of the - * logo is not reasonably feasible for technical reasons, the Appropriate Legal Notices - * must display the words "Powered by KnowledgeTree" and retain the original - * copyright notice. - * Contributor( s): ______________________________________ - * - */ - -require_once('../../config/dmsDefaults.php'); -require_once(KT_LIB_DIR . '/security/Esignature.inc.php'); - -/** - * Class handles the electronic signatures - * - * @author KnowledgeTree Team - * @package Electronic Signatures - */ -class KTElectronicSignatures -{ - /** - * The error returned when attempting to authenticate - * - * @access private - * @var $error - */ - private $error; - - /** - * If the system is locked for the session - * - * @access private - * @var bool - */ - private $lock; - - /** - * If electronic signatures are enabled - * - * @access private - * @var bool - */ - private $enabled; - - /** - * The ESignature object - * - * @access private - * @var ESignature object - */ - private $eSignature; - - /** - * Constructor function for the class - * - * @author KnowledgeTree Team - * @access public - * @return KTElectronicSignatures - */ - public function KTElectronicSignatures() - { - $this->eSignature = new ESignature(); - $this->lock = $this->eSignature->isLocked(); - $this->enabled = $this->eSignature->isEnabled(); - } - - /** - * Returns the form requesting the signature - * - * @author KnowledgeTree Team - * @access public - * @return html - */ - public function getSignatureForm($head) - { - $oTemplating =& KTTemplating::getSingleton(); - $oTemplate = $oTemplating->loadTemplate('ktstandard/signatures/signature_form'); - $aTemplateData = array( - 'head' => $head - ); - - if(!$this->enabled){ - return 'disabled'; - } - - if($this->lock){ - $this->error = $this->eSignature->getLockMsg(); - return $this->getError(); - } - return $oTemplate->render($aTemplateData); - } - - /** - * Attempts authentication of the signature - * - * @author KnowledgeTree Team - * @access public - * @param string $username The users username. - * @param string $password The users password. - * @param string $comment A comment on the action performed. - * @return bool True if authenticated | False if rejected - */ - public function authenticateSignature($username, $password, $comment, $action, $type, $details) - { - $result = $this->eSignature->sign($username, $password, $comment, $action, $type, $details); - if(!$result){ - $this->error = $this->eSignature->getError(); - $this->lock = $this->eSignature->isLocked(); - } - return $result; - } - - /** - * Returns the error from the attempted signature - * - * @author KnowledgeTree Team - * @access public - * @return string - */ - public function getError() - { - return '
'.$this->error.'
'; - } - - /** - * Checks whether the electronic signature system is locked at which point authentication is not allowed. - * - * @author KnowledgeTree Team - * @access public - * @return bool - */ - public function isLocked() - { - return $this->lock; - } -} - -$sign = new KTElectronicSignatures(); - -// User has signed so authenticate the signature -if($_POST['action'] == 'submit'){ - $user = $_POST['sign_username']; - $password = $_POST['sign_password']; - $comment = $_POST['sign_comment']; - $action = $_POST['sign_action']; - $type = $_POST['sign_type']; - $details = $_POST['sign_details']; - - if($sign->authenticateSignature($user, $password, $comment, $action, $type, $details)){ - echo 'success'; - exit; - } - echo $sign->getError(); - if($sign->isLocked()){ - exit; - } -} - -$head = $_POST['head']; -echo $sign->getSignatureForm($head); - -exit; -?> \ No newline at end of file diff --git a/resources/css/kt-framing.css b/resources/css/kt-framing.css index e4a2f38..aac716e 100644 --- a/resources/css/kt-framing.css +++ b/resources/css/kt-framing.css @@ -2311,44 +2311,36 @@ body #content #add_dashlet } -/* ================= Electronic signature popup - override ExtJS CSS ================= */ +/* ================= Ajax popup - override ExtJS CSS ================= */ -#signature-panel { - background: transparent; -} - -#signature { - background: transparent; -} - -#sign_here { +#popup_content { background: #FFF; color: #000; padding: 5px; padding-bottom: 10px; } -#sign_here h2 { +#popup_content h2 { font-size: 110%; margin-bottom: 5px; } -#sign_here .input_field { +#popup_content .input_field { margin-bottom: 10px; } -#sign_here .required { +#popup_content .required { margin-left: 0.5em; padding-left: 10px; color: transparent; background: transparent url(../graphics/required.png) center left no-repeat; } -#sign_here .descriptiveText { +#popup_content .descriptiveText { color: #666; } -#sign_here .form_actions a { +#popup_content .form_actions a { border: 1px solid #ccc; background: #fdfdfd; color: #333; @@ -2358,14 +2350,14 @@ body #content #add_dashlet text-decoration: none; } -#sign_here .error { +#popup_content .error { padding: 0.5em 1em; border: 1px solid #ffc21e; margin-bottom: 10px; padding-left: 25px; } -#sign_here .error { +#popup_content .error { background: #ffdd80 url(../../thirdparty/icon-theme/16x16/status/dialog-warning.gif) 2px center no-repeat; } diff --git a/resources/js/signature.js b/resources/js/signature.js deleted file mode 100644 index 93a2372..0000000 --- a/resources/js/signature.js +++ /dev/null @@ -1,130 +0,0 @@ -var win; -var head; -var request; -var request_type; -var request_details; - -/* -* Create the electronic signature dialog -*/ -var showSignatureForm = function(head, action, type, request, request_type, details){ - createSignature(); - - var sUrl = rootURL + '/plugins/ktstandard/KTElectronicSignatures.php'; - - if(details === undefined) details = ''; - if(request_type === undefined) request_type = 'submit'; - if(type === undefined) type = 'system'; - - this.head = head; - this.request = request; - this.request_type = request_type; - this.request_details = new Array(); - this.request_details[0] = action; - this.request_details[1] = type; - this.request_details[2] = details; - - // create the window - this.win = new Ext.Window({ - applyTo : 'signature', - layout : 'fit', - width : 360, - height : 310, - closeAction :'destroy', - y : 150, - shadow: false, - modal: true - }); - this.win.show(); - - var sUrl = rootURL + '/plugins/ktstandard/KTElectronicSignatures.php'; - var info = document.getElementById('sign_here'); - - Ext.Ajax.request({ - url: sUrl, - success: function(response) { - if(response.responseText == 'disabled'){ - // continue the action - if(this.request_type == 'redirect'){ - window.location.href = this.request; - }else{ - window.document.forms[this.request].submit(); - } - return; - } - info.innerHTML = response.responseText; - }, - failure: function(response) { - alert('Error. Couldn\'t create signature form.'); - }, - params: { - head: head - } - }); -} - -/* -* Create the html required to initialise the signature panel -*/ -var createSignature = function() { - - if(document.getElementById('signature-panel')){ - p = document.getElementById('signature-panel'); - }else { - p = document.getElementById('pageBody').appendChild(document.createElement('div')); - p.id = 'signature-panel'; - } - - inner = '
Electronic Signature
'; - inner = inner + '
{$head} - -

This action requires re-authentication.

-
- -
-

-required -
- -

- -

-required -
- -

- -

-required -
- -

- -
- -{i18n}OK{/i18n}  -{i18n}Cancel{/i18n} - -
-
\ No newline at end of file -- libgit2 0.21.4