adding vmailmgrd backend and making change_password_init hook work.
authortokul <tokul@7612ce4b-ef26-0410-bec9-ea0150e637f0>
Tue, 8 Feb 2005 19:19:10 +0000 (19:19 +0000)
committertokul <tokul@7612ce4b-ef26-0410-bec9-ea0150e637f0>
Tue, 8 Feb 2005 19:19:10 +0000 (19:19 +0000)
git-svn-id: https://svn.code.sf.net/p/squirrelmail/code/trunk/squirrelmail@8827 7612ce4b-ef26-0410-bec9-ea0150e637f0

plugins/change_password/backend/vmailmgrd.php [new file with mode: 0644]
plugins/change_password/options.php

diff --git a/plugins/change_password/backend/vmailmgrd.php b/plugins/change_password/backend/vmailmgrd.php
new file mode 100644 (file)
index 0000000..208a677
--- /dev/null
@@ -0,0 +1,200 @@
+<?php
+/**
+ * Change password vmailmgrd backend
+ *
+ * Backend won't work, if vmail.inc file is not included. vmail.inc file 
+ * should be part of your vmailmgr install. In some cases it is included in 
+ * separate package.
+ *
+ * If you use modified vmail.inc, it must provide vchpass() function that 
+ * acts same way as stock (vmailmgr v.0.96.9) vmail.inc function call 
+ * and other vmail.inc functions should use same $vm_tcphost and 
+ * $vm_tcphost_port globals as used by stock vm_daemon_raw() function call.
+ * If you have heavily modified vmail.inc and this backend does not work 
+ * correctly - recheck, if you can reproduce your problem with stock 
+ * vmail.inc or adjust backend configuration for your site.
+ *
+ * Backend also needs vmailmgrd service. You can find information about 
+ * installing this service in vmailmgr FAQ and vmailmgrd.html.
+ *
+ * Backend might require functions, that are available only in SquirrelMail 
+ * v.1.5.1 and v.1.4.4.
+ *
+ * @version $Id$
+ * @link http://www.vmailmgr.org vmailmgr site
+ * @package plugins
+ * @subpackage change_password
+ */
+
+/* Backend configuration */
+
+/**
+ * path to vmail.inc
+ *
+ * This variable must provide full path to vmail.inc file including filename.
+ * 
+ * WARNING: Don't disable this variable. It must be set to correct value or 
+ * to empty string. If variable is missing, backend can have security problems 
+ * in some php configurations.
+ * @global string $vmail_inc_path
+ */
+global $vmail_inc_path;
+$vmail_inc_path='';
+
+/**
+ * address of vmailmgrd host.
+ *
+ * Leave it empty, if you want to use unix socket
+ * global is used by vmail.inc functions
+ * @global string $vm_tcphost
+ */
+global $vm_tcphost;
+$vm_tcphost='';
+
+/**
+ * port of vmailmgrd
+ *
+ * global is used by vmail.inc functions.
+ * @global integer $vm_tcphost_port
+ */
+global $vm_tcphost_port;
+$vm_tcphost_port=322;
+
+/**
+ * Option that controls use of 8bit passwords
+ * Use of such passwords is not safe, because squirrelmail interface
+ * can be running in different charsets.
+ * @global boolean
+ */
+global $cpw_vmailmgrd_8bitpw;
+$cpw_vmailmgrd_8bitpw=false;
+
+/* end of backend configuration */
+
+
+/**
+ * Init change_password plugin hooks. 
+ */
+global $squirrelmail_plugin_hooks;
+$squirrelmail_plugin_hooks['change_password_dochange']['vmailmgrd'] =
+        'cpw_vmailmgrd_dochange';
+$squirrelmail_plugin_hooks['change_password_init']['vmailmgrd'] =
+        'cpw_vmailmgrd_init';
+
+
+/**
+ * Use this function to do any backend-specific initialisation,
+ * e.g. checking requirements, before the password change form
+ * is displayed to the user.
+ */
+function cpw_vmailmgrd_init(){
+    global $vmail_inc_path, $color, $username;
+
+    /**
+     * If SM_PATH isn't defined, define it.  Required to include files.
+     * @ignore
+     */
+    if (!defined('SM_PATH'))  {
+        define('SM_PATH','../../../');
+    }
+
+    // load error_box() function
+    include_once(SM_PATH . 'functions/display_messages.php');
+
+    if ($vmail_inc_path=='' || ! file_exists($vmail_inc_path)) {
+        // $vmail_inc_path is not set or file does not exist
+        error_box(_("Incorrent path to vmail.inc file."),$color);
+        // close html and stop script execution
+        echo "</body></html>\n";
+        exit();
+    }
+
+    include_once($vmail_inc_path);
+
+    if (! function_exists('vchpass')) {
+        // included vmail.inc does not have required functions.
+        error_box(_("Invalid or corrupted vmail.inc file."),$color);
+        // close html and stop script execution
+        echo "</body></html>\n";
+        exit();
+    }
+
+    if (! preg_match("/(.*)\@(.*)/", $username)) {
+        // username does not match vmailmgr syntax
+        error_box(_("Invalid user."),$color);
+        // close html and stop script execution
+        echo "</body></html>\n";
+        exit();
+    }
+}
+
+
+/**
+ * function used to change password in change_password plugin hooks.
+ *
+ * @param array data The username/currentpw/newpw data.
+ * @return array Array of error messages.
+ */
+function cpw_vmailmgrd_dochange($data)
+{
+    global $cpw_vmailmgrd_8bitpw;
+
+    /**
+     * getting params from hook function.
+     */
+    $username = $data['username'];
+    $curpw = $data['curpw'];
+    $newpw = $data['newpw'];
+
+    $msgs = array();
+
+    // check for new 8bit password
+    if (! $cpw_vmailmgrd_8bitpw && sq_is8bit($newpw)) {
+        // 8bit chars in password when backend is configured to block them
+        array_push($msgs,CPW_INVALID_PW);
+        return $msgs;
+    }
+
+    // extract username and domain
+    if (preg_match("/(.*)\@(.*)/", $username, $parts)) {
+        $vm_user=$parts[1];
+        $vm_domain=$parts[2];
+    }
+
+    // check if old password matches
+    $vmgrd_response1 = cpw_vmailmgrd_passwd($vm_user,$vm_domain,$curpw,$curpw);
+    if ($vmgrd_response1[0]!=0) {
+        array_push($msgs, CPW_CURRENT_NOMATCH);
+        return $msgs;
+    }
+
+    // change password
+    $vmgrd_response2 = cpw_vmailmgrd_passwd($vm_user,$vm_domain,$curpw,$newpw);
+    if ($vmgrd_response2[0]!=0) {
+        // TODO: add vmail.inc error message parser.
+        array_push($msgs, $vmgrd_response2[1]);
+    }
+
+    return $msgs;
+}
+
+/**
+ * function that calls required vmail.inc functions and returns error codes.
+ *
+ * Information about vmailmgr return codes.
+ * vmailmgr functions return array with two keys.
+ * Array(
+ *    [0] => error code, integer (0=no error)
+ *    [1] => error message, string
+ * )
+ * @return array
+ */
+function cpw_vmailmgrd_passwd($user,$domain,$oldpass,$newpass) {
+    global $vmail_inc_path;
+
+    // variable should be checked by cpw_vmailmgrd_init function
+    include_once($vmail_inc_path);
+
+    return vchpass($domain,$oldpass,$user,$newpass);
+}
+?>
\ No newline at end of file
index 983be0d..3a9d69c 100644 (file)
@@ -20,6 +20,11 @@ require_once (SM_PATH . 'plugins/change_password/functions.php');
 require_once (SM_PATH . 'plugins/change_password/config.php');
 require_once (SM_PATH . 'functions/forms.php');
 
+// you must load backend configuration here in order to get working change_password_init hook.
+if (file_exists(SM_PATH . 'plugins/change_password/backend/'.$cpw_backend.'.php')) {
+   include_once(SM_PATH . 'plugins/change_password/backend/'.$cpw_backend.'.php');
+}
+
 /* the form was submitted, go for it */
 if(sqgetGlobalVar('cpw_go', $cpw_go, SQ_POST)) {