zimbraSingle.php 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794
  1. <?php
  2. /**
  3. * WHMCS Zimbra Provisioning Module
  4. *
  5. * Provisioning for private mailboxes on a Zimbra Server
  6. *
  7. * @see https://www.zimbra.com
  8. * @copyright Copyright (c) Thurdata GmbH 2020
  9. * @license GPL
  10. */
  11. if (!defined('WHMCS')) {
  12. die('This file cannot be accessed directly');
  13. }
  14. use WHMCS\Database\Capsule;
  15. /**
  16. * Requires this PHP api to make soap calls and parse responses
  17. * This is an extend version of:
  18. * @see https://github.com/alloylab/zimbra-admin-api-soap-php
  19. */
  20. require_once(__DIR__ . '/api/Zm/Auth.php');
  21. require_once(__DIR__ . '/api/Zm/Account.php');
  22. require_once(__DIR__ . '/api/Zm/Domain.php');
  23. require_once(__DIR__ . '/api/Zm/Server.php');
  24. /**
  25. * Helper function to find values of a named key in a multidimensional arrays or objects
  26. *
  27. * @param array $haystack mixed data
  28. * @param string $needle key to search for values
  29. * @return array of values
  30. */
  31. function zimbraSingleFindAll($haystack, $needle) {
  32. $values = array();
  33. $iterator = new RecursiveArrayIterator((array)$haystack);
  34. $recursive = new RecursiveIteratorIterator(
  35. $iterator,
  36. RecursiveIteratorIterator::SELF_FIRST
  37. );
  38. foreach ($recursive as $key => $value) {
  39. if ($key === $needle) {
  40. array_push($values, $value);
  41. }
  42. }
  43. return $values;
  44. }
  45. /**
  46. * server side password check
  47. *
  48. * recheck the client side password check
  49. * in case that the client side check has been disabled
  50. *
  51. * @param string $pwd password
  52. *
  53. * @return string missing features or null if the password matches our needs
  54. */
  55. function zimbraSingleCheckPassword($pwd) {
  56. if (strlen($pwd) < 8) {
  57. return 'Das das Passwort ist zu kurz. Es werden mind. 8 Zeichen benötigt';
  58. }
  59. if (!preg_match('#[0-9]+#', $pwd)) {
  60. return 'Das Passwort muss mindestens eine Zahl enthalten';
  61. }
  62. if (!preg_match('#[A-Z]+#', $pwd)) {
  63. return 'Das Passwort muss mindestens einen Grossbuchstaben (A-Z) enthalten';
  64. }
  65. if (!preg_match('#[a-z]+#', $pwd)) {
  66. return 'Das Passwort muss mindestens einen Kleinbuchstaben (a-z) enthalten';
  67. }
  68. if (!preg_match('#[^\w]+#', $pwd)) {
  69. return 'Das Passwort muss mindestens ein Sonderzeichen (.,-:=) enthalten';
  70. }
  71. return null;
  72. }
  73. /**
  74. * Define module related meta data.
  75. *
  76. * Values returned here are used to determine module related abilities and
  77. * settings.
  78. *
  79. * @see https://developers.whmcs.com/provisioning-modules/meta-data-params/
  80. *
  81. * @return array
  82. */
  83. function zimbraSingle_MetaData() {
  84. return array(
  85. 'DisplayName' => 'Zimbra Single Mailbox Provisioning',
  86. 'APIVersion' => '1.2',
  87. 'DefaultNonSSLPort' => '7071',
  88. 'DefaultSSLPort' => '7071',
  89. 'RequiresServer' => true,
  90. 'ServiceSingleSignOnLabel' => 'Login to Zimbra',
  91. 'AdminSingleSignOnLabel' => 'Login to Zimbra Admin'
  92. );
  93. }
  94. /**
  95. * Test connection to a Zimbra server with the given server parameters.
  96. *
  97. * Allows an admin user to verify that an API connection can be
  98. * successfully made with the given configuration parameters for a
  99. * server.
  100. *
  101. * When defined in a module, a Test Connection button will appear
  102. * alongside the Server Type dropdown when adding or editing an
  103. * existing server.
  104. *
  105. * @param array $params common module parameters
  106. *
  107. * @see https://developers.whmcs.com/provisioning-modules/module-parameters/
  108. *
  109. * @return array
  110. */
  111. function zimbraSingle_TestConnection($params) {
  112. $auth = new Zm_Auth($params['serverhostname'], $params['serverusername'], $params['serverpassword'], 'admin');
  113. $login = $auth->login();
  114. if(is_a($login, 'Exception')) {
  115. logModuleCall(
  116. 'zimbrasingle',
  117. __FUNCTION__,
  118. $params,
  119. 'Connection failed, cannot login to ' . $params['serverhostname'],
  120. $login->getMessage()
  121. );
  122. return array(
  123. 'success' => false,
  124. 'error' => 'Connection failed, cannot login to ' . $params['serverhostname'],
  125. );
  126. }
  127. return array(
  128. 'success' => true,
  129. 'error' => '',
  130. );
  131. }
  132. /**
  133. * Client area output logic handling.
  134. *
  135. * This function is used to define module specific client area output. It should
  136. * return an array consisting of a template file and optional additional
  137. * template variables to make available to that template.
  138. *
  139. * The template file you return can be one of two types:
  140. *
  141. * * tabOverviewModuleOutputTemplate - The output of the template provided here
  142. * will be displayed as part of the default product/service client area
  143. * product overview page.
  144. *
  145. * * tabOverviewReplacementTemplate - Alternatively using this option allows you
  146. * to entirely take control of the product/service overview page within the
  147. * client area.
  148. *
  149. * Whichever option you choose, extra template variables are defined in the same
  150. * way. This demonstrates the use of the full replacement.
  151. *
  152. * Please Note: Using tabOverviewReplacementTemplate means you should display
  153. * the standard information such as pricing and billing details in your custom
  154. * template or they will not be visible to the end user.
  155. *
  156. * @param array $params common module parameters
  157. *
  158. * @see https://developers.whmcs.com/provisioning-modules/module-parameters/
  159. *
  160. * @return array
  161. */
  162. function zimbraSingle_ClientArea($params) {
  163. $clientInfo = array();
  164. $api = new Zm_Auth($params['serverhostname'], $params['serverusername'], $params['serverpassword'], 'admin');
  165. $login = $api->login();
  166. if(is_a($login, 'Exception')) {
  167. logModuleCall(
  168. 'zimbrasingle',
  169. __FUNCTION__,
  170. $params,
  171. 'Error: cannot login to ' . $accessData['zimbraServer'],
  172. $login->getMessage()
  173. );
  174. return false;
  175. }
  176. $apiAccountManager = new Zm_Account($api);
  177. $accountInfo = $apiAccountManager->getAccountInfo($params['username']);
  178. if(is_a($accountInfo, 'Exception')) {
  179. logModuleCall(
  180. 'zimbrasingle',
  181. __FUNCTION__,
  182. $params,
  183. 'Error: could not gather informations for ' . $params['username'],
  184. $accountInfo
  185. );
  186. return false;
  187. }
  188. $webmailUrl = zimbraSingleFindAll($accountInfo, 'PUBLICMAILURL');
  189. $clientInfo['webmailurl'] = $webmailUrl[0]['DATA'];
  190. return array(
  191. 'templatefile' => 'clientarea',
  192. 'vars' => $clientInfo,
  193. );
  194. }
  195. /**
  196. * Usage Update
  197. *
  198. * Important: Runs daily per server not per product
  199. * Run Manually: /admin/reports.php?report=disk_usage_summary&action=updatestats
  200. * @param array $params common module parameters
  201. *
  202. * @see https://developers.whmcs.com/provisioning-modules/usage-update/
  203. */
  204. function zimbraSingle_UsageUpdate($params) {
  205. $api = new Zm_Auth($params['serverhostname'], $params['serverusername'], $params['serverpassword'], 'admin');
  206. $login = $api->login();
  207. if(is_a($login, 'Exception')) {
  208. logModuleCall(
  209. 'zimbrasingle',
  210. __FUNCTION__,
  211. $params,
  212. 'Error: cannot login to ' . $params['serverhostname'],
  213. $login->getMessage()
  214. );
  215. return false;
  216. }
  217. $apiAccountManager = new Zm_Account($api);
  218. $productsObj = Capsule::table('tblhosting')
  219. ->select('*')
  220. ->where('server', '=', $params['serverid'])
  221. ->where('domainstatus', '=', 'Active')
  222. ->get();
  223. foreach((array)$productsObj as $productObj) {
  224. $product = get_object_vars($productObj[0]);
  225. $accountQuota = $apiAccountManager->getQuota($product['username']);
  226. if(is_a($accountQuota, 'Exception')) {
  227. logModuleCall(
  228. 'zimbrasingle',
  229. __FUNCTION__,
  230. $params,
  231. 'Error : could not find quota for ' . $product['username'],
  232. $accountQuota
  233. );
  234. continue;
  235. }
  236. $mboxInfo = $apiAccountManager->getMailbox($product['username']);
  237. if(is_a($mboxInfo, 'Exception')) {
  238. logModuleCall(
  239. 'zimbrasingle',
  240. __FUNCTION__,
  241. $params,
  242. 'Error: could not fetch mailbox info for ' . $product['username'],
  243. $mboxInfo
  244. );
  245. continue;
  246. }
  247. $mboxSize = $mboxInfo['S'];
  248. try {
  249. Capsule::table('tblhosting')
  250. ->where('id', '=', $product['id'])
  251. ->update(
  252. array(
  253. 'diskusage' => round($mboxSize / 1048576,2),
  254. 'disklimit' => round($accountQuota / 1048576,2),
  255. 'lastupdate' => Capsule::raw('now()')
  256. )
  257. );
  258. } catch (\Exception $e) {
  259. logModuleCall(
  260. 'zimbrasingle',
  261. __FUNCTION__,
  262. $params,
  263. 'Error: could update usage information for ' . $product['username'],
  264. $e->getMessage()
  265. );
  266. }
  267. }
  268. }
  269. /**
  270. * Change the password for a Zimbra account.
  271. *
  272. * Called when a password change is requested. This can occur either due to a
  273. * client requesting it via the client area or an admin requesting it from the
  274. * admin side.
  275. *
  276. * This option is only available to client end users when the product is in an
  277. * active status.
  278. *
  279. * @param array $params common module parameters
  280. *
  281. * @see https://developers.whmcs.com/provisioning-modules/module-parameters/
  282. *
  283. * @return string 'success' or an error message
  284. */
  285. function zimbraSingle_ChangePassword($params) {
  286. $checkPassword = zimbraSingleCheckPassword($params['password']);
  287. if ($checkPassword != null) {
  288. return $checkPassword;
  289. }
  290. $api = new Zm_Auth($params['serverhostname'], $params['serverusername'], $params['serverpassword'], 'admin');
  291. $login = $api->login();
  292. if(is_a($login, 'Exception')) {
  293. logModuleCall(
  294. 'zimbrasingle',
  295. __FUNCTION__,
  296. $params,
  297. 'Error: cannot login to ' . $params['serverhostname'],
  298. $login->getMessage()
  299. );
  300. return false;
  301. }
  302. $apiAccountManager = new Zm_Account($api);
  303. $response = $apiAccountManager->setAccountPassword($params['username'], $params['password']);
  304. if(is_a($response, 'Exception')) {
  305. logModuleCall(
  306. 'zimbrasingle',
  307. __FUNCTION__,
  308. $params,
  309. 'Error: password could not be set for ' . $params['username'],
  310. $response
  311. );
  312. return false;
  313. }
  314. return 'success';
  315. }
  316. /**
  317. * Provision a new instance of a Zimbra account.
  318. *
  319. * Attempt to provision a new Zimbra mail account. This is
  320. * called any time provisioning is requested inside of WHMCS. Depending upon the
  321. * configuration, this can be any of:
  322. * * When a new order is placed
  323. * * When an invoice for a new order is paid
  324. * * Upon manual request by an admin user
  325. *
  326. * @param array $params common module parameters
  327. *
  328. * @see https://developers.whmcs.com/provisioning-modules/module-parameters/
  329. *
  330. * @return string 'success' or an error message
  331. */
  332. function zimbraSingle_CreateAccount($params) {
  333. $api = new Zm_Auth($params['serverhostname'], $params['serverusername'], $params['serverpassword'], 'admin');
  334. $login = $api->login();
  335. if(is_a($login, 'Exception')) {
  336. logModuleCall(
  337. 'zimbrasingle',
  338. __FUNCTION__,
  339. $params,
  340. 'Error: cannot login to ' . $params['serverhostname'],
  341. $login->getMessage()
  342. );
  343. return $login->getMessage();
  344. }
  345. $params['username'] = $params['customfields']['username'] . '@' . $params['customfields']['maildomain'];
  346. $apiAccountManager = new Zm_Account($api);
  347. $accountExists = $apiAccountManager->accountExists($params['username']);
  348. if(is_a($accountExists, 'Exception')) {
  349. logModuleCall(
  350. 'zimbrasingle',
  351. __FUNCTION__,
  352. $params,
  353. 'Error: could not verify ' . $params['username'],
  354. $accountExists
  355. );
  356. return 'Error: could not verify '. $params['username'];
  357. }
  358. if($accountExists === true) {
  359. return 'Error: account already exists ' . $params['username'];
  360. }
  361. $attrs = array();
  362. $attrs['gn'] = $params['customfields']['givenname'];
  363. $attrs['sn'] = $params['customfields']['sn'];
  364. $attrs['displayName'] = $attrs['gn'] . ' ' . $attrs['sn'];
  365. $params['password'] = $params['customfields']['password'];
  366. $cosID = $apiAccountManager->getCosId($params['configoption1']);
  367. if(is_a($cosID, 'Exception')) {
  368. logModuleCall(
  369. 'zimbrasingle',
  370. __FUNCTION__,
  371. $params,
  372. 'Error: could not find serviceclass ' . $params['configoption1'],
  373. $cosID
  374. );
  375. return 'Error: could not find serviceclass ' . $params['configoption1'];
  376. }
  377. $attrs['zimbraCOSId'] = $cosID;
  378. $baseQuota = $params['configoption2'] ? $params['configoption2'] : 1;
  379. $addonQuota = $params['configoptions']['addonQuota'] ? $params['configoptions']['addonQuota'] : 0;
  380. $newQuota = $params['configoptions']['newQuota'] ? $params['configoptions']['newQuota'] : 0;
  381. $addonQuota = $addonQuota + $newQuota;
  382. $params['configoptions']['newQuota'] = 0;
  383. $attrs['zimbraMailQuota'] = ($baseQuota + $addonQuota) * 1073741824;
  384. $zimbraID = $apiAccountManager->createAccount($params['username'], $params['password'], $attrs);
  385. if(is_a($zimbraID, 'Exception')) {
  386. logModuleCall(
  387. 'zimbrasingle',
  388. __FUNCTION__,
  389. $params,
  390. 'Error: could not create account ' . $params['username'],
  391. $zimbraID
  392. );
  393. return 'Error: could not create account ' . $params['username'];
  394. }
  395. try {
  396. Capsule::table('tblhosting')
  397. ->where('id', '=', $params['serviceid'])
  398. ->update(
  399. array(
  400. 'username' => $params['username'],
  401. 'password' => $params['customfields']['password'],
  402. )
  403. );
  404. } catch (\Exception $e) {
  405. logModuleCall(
  406. 'zimbrasingle',
  407. __FUNCTION__,
  408. $params,
  409. 'Error: could save username & password in database',
  410. $e->getMessage()
  411. );
  412. return 'Error: could save username & password in database';
  413. }
  414. return 'success';
  415. }
  416. /**
  417. * Set a Zimbra account to status locked.
  418. *
  419. * Called when a suspension is requested. This is invoked automatically by WHMCS
  420. * when a product becomes overdue on payment or can be called manually by admin
  421. * user.
  422. *
  423. * @param array $params common module parameters
  424. *
  425. * @see https://developers.whmcs.com/provisioning-modules/module-parameters/
  426. *
  427. * @return string 'success' or an error message
  428. */
  429. function zimbraSingle_SuspendAccount($params) {
  430. $api = new Zm_Auth($params['serverhostname'], $params['serverusername'], $params['serverpassword'], 'admin');
  431. $login = $api->login();
  432. if(is_a($login, 'Exception')) {
  433. logModuleCall(
  434. 'zimbrasingle',
  435. __FUNCTION__,
  436. $params,
  437. 'Error: cannot login to ' . $params['serverhostname'],
  438. $login->getMessage()
  439. );
  440. return $login->getMessage();
  441. }
  442. $apiAccountManager = new Zm_Account($api);
  443. $response = $apiAccountManager->setAccountStatus($params['username'], 'locked');
  444. if(is_a($response, 'Exception')) {
  445. logModuleCall(
  446. 'zimbrasingle',
  447. __FUNCTION__,
  448. $params,
  449. 'Error: could not lock account ' . $params['username'],
  450. $response
  451. );
  452. return false;
  453. }
  454. return 'success';
  455. }
  456. /**
  457. * Set a Zimbra account to status active.
  458. *
  459. * Called when an un-suspension is requested. This is invoked
  460. * automatically upon payment of an overdue invoice for a product, or
  461. * can be called manually by admin user.
  462. *
  463. * @param array $params common module parameters
  464. *
  465. * @see https://developers.whmcs.com/provisioning-modules/module-parameters/
  466. *
  467. * @return string 'success' or an error message
  468. */
  469. function zimbraSingle_UnsuspendAccount($params) {
  470. $api = new Zm_Auth($params['serverhostname'], $params['serverusername'], $params['serverpassword'], 'admin');
  471. $login = $api->login();
  472. if(is_a($login, 'Exception')) {
  473. logModuleCall(
  474. 'zimbrasingle',
  475. __FUNCTION__,
  476. $params,
  477. 'Error: cannot login to ' . $params['serverhostname'],
  478. $login->getMessage()
  479. );
  480. return $login->getMessage();
  481. }
  482. $apiAccountManager = new Zm_Account($api);
  483. $response = $apiAccountManager->setAccountStatus($params['username'], 'active');
  484. if(is_a($response, 'Exception')) {
  485. logModuleCall(
  486. 'zimbrasingle',
  487. __FUNCTION__,
  488. $params,
  489. 'Error: could not unlock account ' . $params['username'],
  490. $response
  491. );
  492. return 'Error: could not unlock account ' . $params['username'];
  493. }
  494. return 'success';
  495. }
  496. /**
  497. * Removes a Zimbra account.
  498. *
  499. * Called when a termination is requested. This can be invoked automatically for
  500. * overdue products if enabled, or requested manually by an admin user.
  501. *
  502. * @param array $params common module parameters
  503. *
  504. * @see https://developers.whmcs.com/provisioning-modules/module-parameters/
  505. *
  506. * @return string 'success' or an error message
  507. */
  508. function zimbraSingle_TerminateAccount($params) {
  509. $api = new Zm_Auth($params['serverhostname'], $params['serverusername'], $params['serverpassword'], 'admin');
  510. $login = $api->login();
  511. if(is_a($login, 'Exception')) {
  512. logModuleCall(
  513. 'zimbrasingle',
  514. __FUNCTION__,
  515. $params,
  516. 'Error: cannot login to ' . $params['serverhostname'],
  517. $login->getMessage()
  518. );
  519. return $login->getMessage();
  520. }
  521. $apiAccountManager = new Zm_Account($api);
  522. $accountStatus = $apiAccountManager->getAccountStatus($params['username']);
  523. if(is_a($accountStatus, 'Exception')) {
  524. logModuleCall(
  525. 'zimbrasingle',
  526. __FUNCTION__,
  527. $params,
  528. 'Error: could not verify account '. $params['username'],
  529. $accountStatus
  530. );
  531. return 'Error : account ' . $params['username'] . ' Name could not verified';
  532. }
  533. if ($accountStatus != 'locked') {
  534. return 'Account '. $params['username'] . ' is active, suspend account first!';
  535. }
  536. $response = $apiAccountManager->deleteAccount($params['username']);
  537. if(is_a($response, 'Exception')) {
  538. logModuleCall(
  539. 'zimbrasingle',
  540. __FUNCTION__,
  541. $params,
  542. 'Error: could not remove account '. $params['username'],
  543. $response
  544. );
  545. return 'Error: could not remove account '. $params['username'];
  546. }
  547. return 'success';
  548. }
  549. /**
  550. * Set a new class of service for a Zimbra account.
  551. *
  552. * Called to apply a change of the class of service. It
  553. * is called to provision upgrade or downgrade orders, as well as being
  554. * able to be invoked manually by an admin user.
  555. *
  556. * This same function is called for upgrades and downgrades of both
  557. * products and configurable options.
  558. *
  559. * @param array $params common module parameters
  560. *
  561. * @see https://developers.whmcs.com/provisioning-modules/module-parameters/
  562. *
  563. * @return string 'success' or an error message
  564. */
  565. function zimbraSingle_ChangePackage($params) {
  566. $api = new Zm_Auth($params['serverhostname'], $params['serverusername'], $params['serverpassword'], 'admin');
  567. $login = $api->login();
  568. if(is_a($login, 'Exception')) {
  569. logModuleCall(
  570. 'zimbrasingle',
  571. __FUNCTION__,
  572. $params,
  573. 'Error: cannot login to ' . $params['serverhostname'],
  574. $login->getMessage()
  575. );
  576. return $login->getMessage();
  577. }
  578. $apiAccountManager = new Zm_Account($api);
  579. $response = $apiAccountManager->setAccountCos($params['username'], $params['configoption1']);
  580. if(is_a($response, 'Exception')) {
  581. logModuleCall(
  582. 'zimbrasingle',
  583. __FUNCTION__,
  584. $params,
  585. 'Error: could not set class of service for '. $params['username'],
  586. $response
  587. );
  588. return 'Error: could not set class of service for '. $params['username'];
  589. }
  590. $addonQuota = $params['configoptions']['addonQuota'] ? $params['configoptions']['addonQuota'] : 0;
  591. $newQuota = $params['configoptions']['newQuota'] ? $params['configoptions']['newQuota'] : 0;
  592. $addonQuota = $addonQuota + $newQuota;
  593. $params['configoptions']['newQuota'] = 0;
  594. $attrs['zimbraMailQuota'] = ($baseQuota + $addonQuota) * 1073741824;
  595. $response = $apiAccountManager->modifyAccount($params['username'], $attrs);
  596. if(is_a($response, 'Exception')) {
  597. logModuleCall(
  598. 'zimbrasingle',
  599. __FUNCTION__,
  600. $params,
  601. 'Error: could not update quota for '. $params['username'],
  602. $response
  603. );
  604. return 'Error: could not update quota for '. $params['username'];
  605. }
  606. try {
  607. Capsule::table('tblhosting')
  608. ->where('id', '=', $params['serviceid'])
  609. ->update(
  610. array(
  611. 'disklimit' => $attrs['zimbraMailQuota'],
  612. )
  613. );
  614. } catch (\Exception $e) {
  615. logModuleCall(
  616. 'zimbrasingle',
  617. __FUNCTION__,
  618. $params,
  619. 'Error: could not update quota in database',
  620. $e->getMessage()
  621. );
  622. return 'Error: could not update quota in database';
  623. }
  624. return 'success';
  625. }
  626. /**
  627. * Define Zimbra product configuration options.
  628. *
  629. * Gather classes of service from the Zinbra server.
  630. * Calls a function to create all necessary customfields for the order form using the selected values.
  631. *
  632. * @see https://developers.whmcs.com/provisioning-modules/config-options/
  633. *
  634. * @return array
  635. */
  636. function zimbraSingle_ConfigOptions($params) {
  637. $whmcs = App::self();
  638. $serverGroupID = $whmcs->get_req_var('servergroup');
  639. $serverIDObj = Capsule::table('tblservergroupsrel')
  640. ->select('serverid')
  641. ->where('groupid', '=', $serverGroupID)
  642. ->get();
  643. $serverIDArray = zimbraSingleFindAll($serverIDObj,'serverid');
  644. $server = Capsule::table('tblservers')
  645. ->select('ipaddress', 'username', 'password')
  646. ->where('id', $serverIDArray)
  647. ->where('active', '=', 1)
  648. ->get();
  649. $accessData['zimbraServer'] = $server[0]->ipaddress;
  650. $accessData['adminUser'] = $server[0]->username;
  651. $passDecrypt = localAPI('DecryptPassword', array('password2' => $server[0]->password));
  652. if ($passDecrypt['result'] == 'success') {
  653. $accessData['adminPass'] = $passDecrypt['password'];
  654. } else {
  655. logModuleCall(
  656. 'zimbrasingle',
  657. __FUNCTION__,
  658. $server,
  659. 'Error: could not decrypt password',
  660. $passDecrypt['message']
  661. );
  662. return false;
  663. }
  664. $api = new Zm_Auth($accessData['zimbraServer'], $accessData['adminUser'], $accessData['adminPass'], 'admin');
  665. $login = $api->login();
  666. if(is_a($login, 'Exception')) {
  667. logModuleCall(
  668. 'zimbrasingle',
  669. __FUNCTION__,
  670. $server,
  671. 'Error: cannot login to ' . $accessData['zimbraServer'],
  672. $login->getMessage()
  673. );
  674. return false;
  675. }
  676. $apiAccountManager = new Zm_Account($api);
  677. $cosIDs = $apiAccountManager->getAllCos();
  678. if(is_a($cosIDs, 'Exception')) {
  679. logModuleCall(
  680. 'zimbrasingle',
  681. __FUNCTION__,
  682. $params,
  683. 'Error: could not fetch classes of service',
  684. $cosIDs
  685. );
  686. return false;
  687. }
  688. $cosNames = zimbraSingleFindAll($cosIDs, 'NAME');
  689. $configOptions = array();
  690. $configOptions['cos'] = array(
  691. 'FriendlyName' => 'Class of Service',
  692. 'Type' => 'dropdown',
  693. 'Options' => implode(',', $cosNames),
  694. 'Description' => 'Select COS',
  695. );
  696. $configOptions['quota'] = array(
  697. 'Type' => 'text',
  698. 'Description' => 'Basis Mailbox-Quota für dieses Produkt in GB',
  699. 'Default' => '5',
  700. 'Size' => '3',
  701. 'FriendlyName' => 'Mailbox Quota',
  702. );
  703. return $configOptions;
  704. }
  705. /**
  706. * Perform single sign-on for a given instance of a product/service.
  707. *
  708. * Called when single sign-on is requested for an instance of a product/service.
  709. *
  710. * When successful, returns an URL to which the user should be redirected.
  711. *
  712. * @param array $params common module parameters
  713. *
  714. * @see https://developers.whmcs.com/provisioning-modules/module-parameters/
  715. *
  716. * @return array
  717. */
  718. function zimbraSingle_ServiceSingleSignOn($params) {
  719. $api = new Zm_Auth($params['serverhostname'], $params['serverusername'], $params['serverpassword'], 'admin');
  720. $login = $api->login();
  721. if(is_a($login, 'Exception')) {
  722. logModuleCall(
  723. 'zimbrasingle',
  724. __FUNCTION__,
  725. $params,
  726. 'Error: cannot login to ' . $params['serverhostname'],
  727. $login->getMessage()
  728. );
  729. return array(
  730. 'success' => false,
  731. 'redirectTo' => '',
  732. );
  733. }
  734. $apiDomainManager = new Zm_Domain($api);
  735. $domainOptions = $apiDomainManager->getDomainOptions($params['customfields']['maildomain']);
  736. if(is_a($domainOptions, 'Exception')) {
  737. logModuleCall(
  738. 'zimbrasingle',
  739. __FUNCTION__,
  740. $params,
  741. 'Error : could not fetch options for ' . $params['customfields']['maildomain'],
  742. $domainOptions
  743. );
  744. return array(
  745. 'success' => false,
  746. 'redirectTo' => '',
  747. );
  748. }
  749. $preAuthKey = $domainOptions['zimbraPreAuthKey'];
  750. $apiAccountManager = new Zm_Account($api);
  751. $accountInfo = $apiAccountManager->getAccountInfo($params['username']);
  752. if(is_a($accountInfo, 'Exception')) {
  753. logModuleCall(
  754. 'zimbrasingle',
  755. __FUNCTION__,
  756. $params,
  757. 'Error: could not gather informations for ' . $params['username'],
  758. $accountInfo
  759. );
  760. return array(
  761. 'success' => false,
  762. 'redirectTo' => '',
  763. );
  764. }
  765. $webmailUrl = zimbraSingleFindAll($accountInfo, 'PUBLICMAILURL');
  766. $timestamp=time()*1000;
  767. $preauthToken=hash_hmac('sha1', $params['username'] . '|name|0|' . $timestamp, $preAuthKey);
  768. $preauthURL = $webmailUrl[0]['DATA'] . '/service/preauth?account=' . $params['username'] . '&by=name&timestamp=' . $timestamp .'&expires=0&preauth='. $preauthToken;
  769. return array(
  770. 'success' => true,
  771. 'redirectTo' => $preauthURL,
  772. );
  773. }