From 4baf96a4ca1621a267c10c67e84e80e6bf72dbfd Mon Sep 17 00:00:00 2001
From: Aleksander Machniak <alec@alec.pl>
Date: Mon, 08 Sep 2014 03:50:59 -0400
Subject: [PATCH] Added license headers to driver files, CS fixes
---
plugins/password/drivers/plesk.php | 359 ++++++++++++++++++++++++++++++-----------------------------
1 files changed, 183 insertions(+), 176 deletions(-)
diff --git a/plugins/password/drivers/plesk.php b/plugins/password/drivers/plesk.php
index 6f646d2..d0a511f 100644
--- a/plugins/password/drivers/plesk.php
+++ b/plugins/password/drivers/plesk.php
@@ -1,21 +1,33 @@
<?php
+
/**
* Roundcube Password Driver for Plesk-RPC.
*
* This driver changes a E-Mail-Password via Plesk-RPC
* Deps: PHP-Curl, SimpleXML
*
- * @author Cyrill von Wattenwyl <cyrill.vonwattenwyl@adfinis-sygroup.ch>
- * @copyright Adfinis SyGroup AG, 2014
- * @license GNU GPL v3
+ * @author Cyrill von Wattenwyl <cyrill.vonwattenwyl@adfinis-sygroup.ch>
+ * @copyright Adfinis SyGroup AG, 2014
*
* Config needed:
- * $config['password_plesk_host'] = '10.0.0.5';
- * $config['password_plesk_user'] = 'admin';
- * $config['password_plesk_pass'] = 'pass';
- * $config['password_plesk_rpc_port'] = 8443;
- * $config['password_plesk_rpc_path'] = enterprise/control/agent.php;
+ * $config['password_plesk_host'] = '10.0.0.5';
+ * $config['password_plesk_user'] = 'admin';
+ * $config['password_plesk_pass'] = 'pass';
+ * $config['password_plesk_rpc_port'] = 8443;
+ * $config['password_plesk_rpc_path'] = enterprise/control/agent.php;
*
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see http://www.gnu.org/licenses/.
*/
/**
@@ -23,45 +35,44 @@
*
* See {ROUNDCUBE_ROOT}/plugins/password/README for API description
*
- * @author Cyrill von Wattenwyl <cyrill.vonwattenwyl@adfinis-sygroup.ch>
+ * @author Cyrill von Wattenwyl <cyrill.vonwattenwyl@adfinis-sygroup.ch>
*/
-class rcube_plesk_password {
+class rcube_plesk_password
+{
+ /**
+ * this method is called from roundcube to change the password
+ *
+ * roundcube allready validated the old password so we just need to change it at this point
+ *
+ * @author Cyrill von Wattenwyl <cyrill.vonwattenwyl@adfinis-sygroup.ch>
+ * @param string $curpass Current password
+ * @param string $newpass New password
+ * @returns int PASSWORD_SUCCESS|PASSWORD_ERROR
+ */
+ function save($currpass, $newpass)\
+ {
+ // get config
+ $rcmail = rcmail::get_instance();
+ $host = $rcmail->config->get('password_plesk_host');
+ $user = $rcmail->config->get('password_plesk_user');
+ $pass = $rcmail->config->get('password_plesk_pass');
+ $port = $rcmail->config->get('password_plesk_rpc_port');
+ $path = $rcmail->config->get('password_plesk_rpc_path');
- /**
- * this method is called from roundcube to change the password
- *
- * roundcube allready validated the old password so we just need to change it at this point
- *
- * @author Cyrill von Wattenwyl <cyrill.vonwattenwyl@adfinis-sygroup.ch>
- * @param string $curpass current password
- * @param string $newpass new password
- * @returns PASSWORD_SUCCESS|PASSWORD_ERROR
- */
- function save($currpass, $newpass) {
+ // create plesk-object
+ $plesk = new plesk_rpc;
+ $plesk->init($host, $port, $path, $user, $pass);
- // get config
- $rcmail = rcmail::get_instance();
- $host = $rcmail->config->get('password_plesk_host');
- $user = $rcmail->config->get('password_plesk_user');
- $pass = $rcmail->config->get('password_plesk_pass');
- $port = $rcmail->config->get('password_plesk_rpc_port');
- $path = $rcmail->config->get('password_plesk_rpc_path');
+ // try to change password and return the status
+ $result = $plesk->change_mailbox_password($_SESSION['username'], $newpass);
+ //$plesk->destroy();
- // create plesk-object
- $plesk = new plesk_rpc;
- $plesk->init($host, $port, $path, $user, $pass);
+ if ($result) {
+ return PASSWORD_SUCCESS;
+ }
- // try to change password and return the status
- $result = $plesk->change_mailbox_password($_SESSION['username'], $newpass);
- //$plesk->destroy();
-
- if ($result) {
- return PASSWORD_SUCCESS;
- }
-
- return PASSWORD_ERROR;
- }
-
+ return PASSWORD_ERROR;
+ }
}
@@ -73,162 +84,158 @@
*
* Documentation of Plesk RPC-API: http://download1.parallels.com/Plesk/PP11/11.0/Doc/en-US/online/plesk-api-rpc/
*
- * @author Cyrill von Wattenwyl <cyrill.vonwattenwyl@adfinis-sygroup.ch>
+ * @author Cyrill von Wattenwyl <cyrill.vonwattenwyl@adfinis-sygroup.ch>
*/
-class plesk_rpc {
+class plesk_rpc
+{
+ /**
+ * init plesk-rpc via curl
+ *
+ * @param string $host plesk host
+ * @param string $port plesk rpc port
+ * @param string $path plesk rpc path
+ * @param string $user plesk user
+ * @param string $user plesk password
+ * @returns void
+ */
+ function init($host, $port, $path, $user, $pass)
+ {
+ $headers = array(
+ sprintf("HTTP_AUTH_LOGIN: %s", $user),
+ sprintf("HTTP_AUTH_PASSWD: %s", $pass),
+ "Content-Type: text/xml"
+ );
- /**
- * init plesk-rpc via curl
- *
- * @author Cyrill von Wattenwyl <cyrill.vonwattenwyl@adfinis-sygroup.ch>
- * @param string $host plesk host
- * @param string $port plesk rpc port
- * @param string $path plesk rpc path
- * @param string $user plesk user
- * @param string $user plesk password
- * @returns void
- */
- function init($host, $port, $path, $user, $pass) {
- $headers = array(
- sprintf("HTTP_AUTH_LOGIN: %s", $user),
- sprintf("HTTP_AUTH_PASSWD: %s", $pass),
- "Content-Type: text/xml"
- );
- $url = sprintf("https://%s:%s/%s", $host, $port, $path);
- $this->curl = curl_init();
- curl_setopt($this->curl, CURLOPT_CONNECTTIMEOUT , 5);
- curl_setopt($this->curl, CURLOPT_SSL_VERIFYHOST , 0);
- curl_setopt($this->curl, CURLOPT_SSL_VERIFYPEER , false);
- curl_setopt($this->curl, CURLOPT_HTTPHEADER , $headers);
- curl_setopt($this->curl, CURLOPT_URL , $url);
- }
+ $url = sprintf("https://%s:%s/%s", $host, $port, $path);
+ $this->curl = curl_init();
+ curl_setopt($this->curl, CURLOPT_CONNECTTIMEOUT , 5);
+ curl_setopt($this->curl, CURLOPT_SSL_VERIFYHOST , 0);
+ curl_setopt($this->curl, CURLOPT_SSL_VERIFYPEER , false);
+ curl_setopt($this->curl, CURLOPT_HTTPHEADER , $headers);
+ curl_setopt($this->curl, CURLOPT_URL , $url);
+ }
- /**
- * send a request to the plesk
- *
- * @author Cyrill von Wattenwyl <cyrill.vonwattenwyl@adfinis-sygroup.ch>
- * @param string $packet XML-Packet to send to Plesk
- * @returns bool request was successfull or not
- */
- function send_request($packet) {
- curl_setopt($this->curl, CURLOPT_RETURNTRANSFER, true);
- curl_setopt($this->curl, CURLOPT_POSTFIELDS, $packet);
- $retval = curl_exec($this->curl);
+ /**
+ * send a request to the plesk
+ *
+ * @param string $packet XML-Packet to send to Plesk
+ * @returns bool request was successfull or not
+ */
+ function send_request($packet)
+ {
+ curl_setopt($this->curl, CURLOPT_RETURNTRANSFER, true);
+ curl_setopt($this->curl, CURLOPT_POSTFIELDS, $packet);
+ $retval = curl_exec($this->curl);
- return $retval;
- }
+ return $retval;
+ }
+ /**
+ * close curl
+ */
+ function destroy(){
+ curl_close($this->curl);
+ }
- /**
- * close curl
- *
- * @author Cyrill von Wattenwyl <cyrill.vonwattenwyl@adfinis-sygroup.ch>
- * @returns void
- */
- function destroy(){
- curl_close($this->curl);
- }
+ /**
+ * Creates an Initial SimpleXML-Object for Plesk-RPC
+ *
+ * @returns object SimpleXML object
+ */
+ function get_request_obj()
+ {
+ $request = new SimpleXMLElement("<packet></packet>");
+ $request->addAttribute("version", "1.6.3.0");
+ return $request;
+ }
- /**
- * Creates an Initial SimpleXML-Object for Plesk-RPC
- *
- * @author Cyrill von Wattenwyl <cyrill.vonwattenwyl@adfinis-sygroup.ch>
- * @returns object SimpleXML object
- */
- function get_request_obj(){
- $request = new SimpleXMLElement("<packet></packet>");
- $request->addAttribute("version", "1.6.3.0");
+ /**
+ * Get all hosting-informations of a domain
+ *
+ * @param string $domain domain-name
+ * @returns object SimpleXML object
+ */
+ function domain_info($domain)
+ {
+ // build xml
+ $request = $this->get_request_obj();
+ $site = $request->addChild("site");
+ $get = $site->addChild("get");
+ $filter = $get->addChild("filter");
- return $request;
- }
+ $filter->addChild("name", utf8_encode($domain));
+ $dataset = $get->addChild("dataset");
- /**
- * Get all hosting-informations of a domain
- *
- * @author Cyrill von Wattenwyl <cyrill.vonwattenwyl@adfinis-sygroup.ch>
- * @param string $domain domain-name
- * @returns object SimpleXML object
- */
- function domain_info($domain){
- // build xml
- $request = $this->get_request_obj();
- $site = $request->addChild("site");
- $get = $site->addChild("get");
- $filter = $get->addChild("filter");
+ $dataset->addChild("hosting");
+ $packet = $request->asXML();
- $filter->addChild("name", utf8_encode($domain));
- $dataset = $get->addChild("dataset");
+ // send the request
+ $res = $this->send_request($packet);
- $dataset->addChild("hosting");
- $packet = $request->asXML();
+ // make it to simple-xml-object
+ $xml = new SimpleXMLElement($res);
- // send the request
- $res = $this->send_request($packet);
+ return $xml;
+ }
- // make it to simple-xml-object
- $xml = new SimpleXMLElement($res);
+ /**
+ * Get psa-id of a domain
+ *
+ * @param string $domain domain-name
+ *
+ * @returns bool|int false if failed and integer if successed
+ */
+ function get_domain_id($domain)
+ {
+ $xml = $this->domain_info($domain);
+ $id = intval($xml->site->get->result->id);
+ $id = (is_int($id)) ? $id : false;
- return $xml;
- }
+ return $id;
+ }
- /**
- * Get psa-id of a domain
- *
- * @author Cyrill von Wattenwyl <cyrill.vonwattenwyl@adfinis-sygroup.ch>
- * @param string $domain domain-name
- * @returns bool|int false if failed and integer if successed
- */
- function get_domain_id($domain){
- $xml = $this->domain_info($domain);
- $id = intval($xml->site->get->result->id);
- $id = (is_int($id)) ? $id : false;
- return $id;
- }
+ /**
+ * Change Password of a mailbox
+ *
+ * @param string $mailbox full email-adress (user@domain.tld)
+ * @param string $newpass new password of mailbox
+ *
+ * @returns bool
+ */
+ function change_mailbox_password($mailbox, $newpass)
+ {
+ list($user, $domain) = explode("@", $mailbox);
+ $domain_id = $this->get_domain_id($domain);
+ // if domain cannot be resolved to an id, do not continue
+ if (!$domain_id) {
+ return false;
+ }
- /**
- * Change Password of a mailbox
- *
- * @author Cyrill von Wattenwyl <cyrill.vonwattenwyl@adfinis-sygroup.ch>
- * @param string $mailbox full email-adress (user@domain.tld)
- * @param string $newpass new password of mailbox
- * @returns bool
- */
- function change_mailbox_password($mailbox, $newpass){
+ // build xml-packet
+ $request = $this -> get_request_obj();
+ $mail = $request -> addChild("mail");
+ $update = $mail -> addChild("update");
+ $add = $update -> addChild("set");
+ $filter = $add -> addChild("filter");
+ $filter->addChild("site-id", $domain_id);
- list($user, $domain) = explode("@", $mailbox);
- $domain_id = $this->get_domain_id($domain);
+ $mailname = $filter->addChild("mailname");
+ $mailname->addChild("name", $user);
- // if domain cannot be resolved to an id, do not continue
- if (!$domain_id) {
- return false;
- }
+ $password = $mailname->addChild("password");
+ $password->addChild("value", $newpass);
+ $password->addChild("type", "plain");
- // build xml-packet
- $request = $this -> get_request_obj();
- $mail = $request -> addChild("mail");
- $update = $mail -> addChild("update");
- $add = $update -> addChild("set");
- $filter = $add -> addChild("filter");
- $filter->addChild("site-id", $domain_id);
+ $packet = $request->asXML();
- $mailname = $filter->addChild("mailname");
- $mailname->addChild("name", $user);
+ // send the request to plesk
+ $res = $this->send_request($packet);
+ $xml = new SimpleXMLElement($res);
+ $res = strval($xml->mail->update->set->result->status);
- $password = $mailname->addChild("password");
- $password->addChild("value", $newpass);
- $password->addChild("type", "plain");
-
- $packet = $request->asXML();
-
- // send the request to plesk
- $res = $this->send_request($packet);
- $xml = new SimpleXMLElement($res);
- $res = strval($xml->mail->update->set->result->status);
-
- return $res == "ok";
- }
+ return $res == "ok";
+ }
}
-
--
Gitblit v1.9.1