zimbraSingle.php 30 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867
  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. $clientInfo['basequota'] = $params['configoption2'] ? $params['configoption2'] : 1;
  189. $clientInfo['addonquota'] = $params['configoptions']['addonQuota'] ? $params['configoptions']['addonQuota'] : 0;
  190. $clientInfo['userquota'] = $clientInfo['basequota'] + $clientInfo['addonquota'];
  191. $clientInfo['mailaddress'] = $params['username'];
  192. $webmailUrl = zimbraSingleFindAll($accountInfo, 'PUBLICMAILURL');
  193. $clientInfo['webmailurl'] = $webmailUrl[0]['DATA'];
  194. $zimbraServer = parse_url($clientInfo['webmailurl'], PHP_URL_HOST);
  195. $clientinfo['zimbraserver'] = $zimbraServer;
  196. logModuleCall(
  197. 'zimbrasingle',
  198. __FUNCTION__,
  199. $params,
  200. 'Debug',
  201. $clientInfo
  202. );
  203. return array(
  204. 'tabOverviewReplacementTemplate' => 'templates/clientarea',
  205. 'vars' => $clientInfo,
  206. );
  207. }
  208. /**
  209. * Usage Update
  210. *
  211. * Important: Runs daily per server not per product
  212. * Run Manually: /admin/reports.php?report=disk_usage_summary&action=updatestats
  213. * @param array $params common module parameters
  214. *
  215. * @see https://developers.whmcs.com/provisioning-modules/usage-update/
  216. */
  217. function zimbraSingle_UsageUpdate($params) {
  218. $api = new Zm_Auth($params['serverhostname'], $params['serverusername'], $params['serverpassword'], 'admin');
  219. $login = $api->login();
  220. if(is_a($login, 'Exception')) {
  221. logModuleCall(
  222. 'zimbrasingle',
  223. __FUNCTION__,
  224. $params,
  225. 'Error: cannot login to ' . $params['serverhostname'],
  226. $login->getMessage()
  227. );
  228. return false;
  229. }
  230. $apiAccountManager = new Zm_Account($api);
  231. $productsObj = Capsule::table('tblhosting')
  232. ->select('*')
  233. ->where('server', '=', $params['serverid'])
  234. ->where('domainstatus', '=', 'Active')
  235. ->get();
  236. foreach((array)$productsObj as $productObj) {
  237. $product = get_object_vars($productObj[0]);
  238. $accountQuota = $apiAccountManager->getQuota($product['username']);
  239. if(is_a($accountQuota, 'Exception')) {
  240. logModuleCall(
  241. 'zimbrasingle',
  242. __FUNCTION__,
  243. $params,
  244. 'Error : could not find quota for ' . $product['username'],
  245. $accountQuota
  246. );
  247. continue;
  248. }
  249. $mboxInfo = $apiAccountManager->getMailbox($product['username']);
  250. if(is_a($mboxInfo, 'Exception')) {
  251. logModuleCall(
  252. 'zimbrasingle',
  253. __FUNCTION__,
  254. $params,
  255. 'Error: could not fetch mailbox info for ' . $product['username'],
  256. $mboxInfo
  257. );
  258. continue;
  259. }
  260. $mboxSize = $mboxInfo['S'];
  261. try {
  262. Capsule::table('tblhosting')
  263. ->where('id', '=', $product['id'])
  264. ->update(
  265. array(
  266. 'diskusage' => round($mboxSize / 1048576),
  267. 'disklimit' => round($accountQuota / 1048576),
  268. 'lastupdate' => Capsule::raw('now()')
  269. )
  270. );
  271. } catch (\Exception $e) {
  272. logModuleCall(
  273. 'zimbrasingle',
  274. __FUNCTION__,
  275. $params,
  276. 'Error: could update usage information for ' . $product['username'],
  277. $e->getMessage()
  278. );
  279. }
  280. }
  281. }
  282. /**
  283. * Change the password for a Zimbra account.
  284. *
  285. * Called when a password change is requested. This can occur either due to a
  286. * client requesting it via the client area or an admin requesting it from the
  287. * admin side.
  288. *
  289. * This option is only available to client end users when the product is in an
  290. * active status.
  291. *
  292. * @param array $params common module parameters
  293. *
  294. * @see https://developers.whmcs.com/provisioning-modules/module-parameters/
  295. *
  296. * @return string 'success' or an error message
  297. */
  298. function zimbraSingle_ChangePassword($params) {
  299. $checkPassword = zimbraSingleCheckPassword($params['password']);
  300. if ($checkPassword != null) {
  301. return $checkPassword;
  302. }
  303. $api = new Zm_Auth($params['serverhostname'], $params['serverusername'], $params['serverpassword'], 'admin');
  304. $login = $api->login();
  305. if(is_a($login, 'Exception')) {
  306. logModuleCall(
  307. 'zimbrasingle',
  308. __FUNCTION__,
  309. $params,
  310. 'Error: cannot login to ' . $params['serverhostname'],
  311. $login->getMessage()
  312. );
  313. return false;
  314. }
  315. $apiAccountManager = new Zm_Account($api);
  316. $response = $apiAccountManager->setAccountPassword($params['username'], $params['password']);
  317. if(is_a($response, 'Exception')) {
  318. logModuleCall(
  319. 'zimbrasingle',
  320. __FUNCTION__,
  321. $params,
  322. 'Error: password could not be set for ' . $params['username'],
  323. $response
  324. );
  325. return false;
  326. }
  327. return 'success';
  328. }
  329. /**
  330. * Provision a new instance of a Zimbra account.
  331. *
  332. * Attempt to provision a new Zimbra mail account. This is
  333. * called any time provisioning is requested inside of WHMCS. Depending upon the
  334. * configuration, this can be any of:
  335. * * When a new order is placed
  336. * * When an invoice for a new order is paid
  337. * * Upon manual request by an admin user
  338. *
  339. * @param array $params common module parameters
  340. *
  341. * @see https://developers.whmcs.com/provisioning-modules/module-parameters/
  342. *
  343. * @return string 'success' or an error message
  344. */
  345. function zimbraSingle_CreateAccount($params) {
  346. $api = new Zm_Auth($params['serverhostname'], $params['serverusername'], $params['serverpassword'], 'admin');
  347. $login = $api->login();
  348. if(is_a($login, 'Exception')) {
  349. logModuleCall(
  350. 'zimbrasingle',
  351. __FUNCTION__,
  352. $params,
  353. 'Error: cannot login to ' . $params['serverhostname'],
  354. $login->getMessage()
  355. );
  356. return $login->getMessage();
  357. }
  358. $params['username'] = $params['customfields']['username'] . '@' . $params['customfields']['maildomain'];
  359. $apiAccountManager = new Zm_Account($api);
  360. $accountExists = $apiAccountManager->accountExists($params['username']);
  361. if(is_a($accountExists, 'Exception')) {
  362. logModuleCall(
  363. 'zimbrasingle',
  364. __FUNCTION__,
  365. $params,
  366. 'Error: could not verify ' . $params['username'],
  367. $accountExists
  368. );
  369. return 'Error: could not verify '. $params['username'];
  370. }
  371. if($accountExists === true) {
  372. return 'Error: account already exists ' . $params['username'];
  373. }
  374. $attrs = array();
  375. $attrs['gn'] = $params['customfields']['givenname'];
  376. $attrs['sn'] = $params['customfields']['sn'];
  377. $attrs['displayName'] = $attrs['gn'] . ' ' . $attrs['sn'];
  378. $params['password'] = $params['customfields']['password'];
  379. $cosID = $apiAccountManager->getCosId($params['configoption1']);
  380. if(is_a($cosID, 'Exception')) {
  381. logModuleCall(
  382. 'zimbrasingle',
  383. __FUNCTION__,
  384. $params,
  385. 'Error: could not find serviceclass ' . $params['configoption1'],
  386. $cosID
  387. );
  388. return 'Error: could not find serviceclass ' . $params['configoption1'];
  389. }
  390. $attrs['zimbraCOSId'] = $cosID;
  391. $baseQuota = $params['configoption2'] ? $params['configoption2'] : 1;
  392. $addonQuota = $params['configoptions']['addonQuota'] ? $params['configoptions']['addonQuota'] : 0;
  393. $newAddQuota = $params['configoptions']['newAddQuota'] ? $params['configoptions']['newAddQuota'] : 0;
  394. $attrs['zimbraMailQuota'] = ($baseQuota + $addonQuota + $newAddQuota) * 1073741824;
  395. $zimbraID = $apiAccountManager->createAccount($params['username'], $params['password'], $attrs);
  396. if(is_a($zimbraID, 'Exception')) {
  397. logModuleCall(
  398. 'zimbrasingle',
  399. __FUNCTION__,
  400. $params,
  401. 'Error: could not create account ' . $params['username'],
  402. $zimbraID
  403. );
  404. return 'Error: could not create account ' . $params['username'];
  405. }
  406. try {
  407. Capsule::table('tblhosting')
  408. ->where('id', '=', $params['serviceid'])
  409. ->update(
  410. array(
  411. 'username' => $params['username'],
  412. 'password' => $params['customfields']['password'],
  413. )
  414. );
  415. } catch (\Exception $e) {
  416. logModuleCall(
  417. 'zimbrasingle',
  418. __FUNCTION__,
  419. $params,
  420. 'Error: could save username & password in database',
  421. $e->getMessage()
  422. );
  423. return 'Error: could save username & password in database';
  424. }
  425. if(zimbraSingleUpdateQuota($params) != 'success') {
  426. return 'Error: could not update addonQuota in database';
  427. };
  428. return 'success';
  429. }
  430. /**
  431. * Set a Zimbra account to status locked.
  432. *
  433. * Called when a suspension is requested. This is invoked automatically by WHMCS
  434. * when a product becomes overdue on payment or can be called manually by admin
  435. * user.
  436. *
  437. * @param array $params common module parameters
  438. *
  439. * @see https://developers.whmcs.com/provisioning-modules/module-parameters/
  440. *
  441. * @return string 'success' or an error message
  442. */
  443. function zimbraSingle_SuspendAccount($params) {
  444. $api = new Zm_Auth($params['serverhostname'], $params['serverusername'], $params['serverpassword'], 'admin');
  445. $login = $api->login();
  446. if(is_a($login, 'Exception')) {
  447. logModuleCall(
  448. 'zimbrasingle',
  449. __FUNCTION__,
  450. $params,
  451. 'Error: cannot login to ' . $params['serverhostname'],
  452. $login->getMessage()
  453. );
  454. return $login->getMessage();
  455. }
  456. $apiAccountManager = new Zm_Account($api);
  457. $response = $apiAccountManager->setAccountStatus($params['username'], 'locked');
  458. if(is_a($response, 'Exception')) {
  459. logModuleCall(
  460. 'zimbrasingle',
  461. __FUNCTION__,
  462. $params,
  463. 'Error: could not lock account ' . $params['username'],
  464. $response
  465. );
  466. return false;
  467. }
  468. return 'success';
  469. }
  470. /**
  471. * Set a Zimbra account to status active.
  472. *
  473. * Called when an un-suspension is requested. This is invoked
  474. * automatically upon payment of an overdue invoice for a product, or
  475. * can be called manually by admin user.
  476. *
  477. * @param array $params common module parameters
  478. *
  479. * @see https://developers.whmcs.com/provisioning-modules/module-parameters/
  480. *
  481. * @return string 'success' or an error message
  482. */
  483. function zimbraSingle_UnsuspendAccount($params) {
  484. $api = new Zm_Auth($params['serverhostname'], $params['serverusername'], $params['serverpassword'], 'admin');
  485. $login = $api->login();
  486. if(is_a($login, 'Exception')) {
  487. logModuleCall(
  488. 'zimbrasingle',
  489. __FUNCTION__,
  490. $params,
  491. 'Error: cannot login to ' . $params['serverhostname'],
  492. $login->getMessage()
  493. );
  494. return $login->getMessage();
  495. }
  496. $apiAccountManager = new Zm_Account($api);
  497. $response = $apiAccountManager->setAccountStatus($params['username'], 'active');
  498. if(is_a($response, 'Exception')) {
  499. logModuleCall(
  500. 'zimbrasingle',
  501. __FUNCTION__,
  502. $params,
  503. 'Error: could not unlock account ' . $params['username'],
  504. $response
  505. );
  506. return 'Error: could not unlock account ' . $params['username'];
  507. }
  508. return 'success';
  509. }
  510. /**
  511. * Removes a Zimbra account.
  512. *
  513. * Called when a termination is requested. This can be invoked automatically for
  514. * overdue products if enabled, or requested manually by an admin user.
  515. *
  516. * @param array $params common module parameters
  517. *
  518. * @see https://developers.whmcs.com/provisioning-modules/module-parameters/
  519. *
  520. * @return string 'success' or an error message
  521. */
  522. function zimbraSingle_TerminateAccount($params) {
  523. $api = new Zm_Auth($params['serverhostname'], $params['serverusername'], $params['serverpassword'], 'admin');
  524. $login = $api->login();
  525. if(is_a($login, 'Exception')) {
  526. logModuleCall(
  527. 'zimbrasingle',
  528. __FUNCTION__,
  529. $params,
  530. 'Error: cannot login to ' . $params['serverhostname'],
  531. $login->getMessage()
  532. );
  533. return $login->getMessage();
  534. }
  535. $apiAccountManager = new Zm_Account($api);
  536. $accountStatus = $apiAccountManager->getAccountStatus($params['username']);
  537. if(is_a($accountStatus, 'Exception')) {
  538. logModuleCall(
  539. 'zimbrasingle',
  540. __FUNCTION__,
  541. $params,
  542. 'Error: could not verify account '. $params['username'],
  543. $accountStatus
  544. );
  545. return 'Error : account ' . $params['username'] . ' Name could not verified';
  546. }
  547. if ($accountStatus != 'locked') {
  548. return 'Account '. $params['username'] . ' is active, suspend account first!';
  549. }
  550. $response = $apiAccountManager->deleteAccount($params['username']);
  551. if(is_a($response, 'Exception')) {
  552. logModuleCall(
  553. 'zimbrasingle',
  554. __FUNCTION__,
  555. $params,
  556. 'Error: could not remove account '. $params['username'],
  557. $response
  558. );
  559. return 'Error: could not remove account '. $params['username'];
  560. }
  561. return 'success';
  562. }
  563. /**
  564. * Set a new class of service for a Zimbra account.
  565. *
  566. * Called to apply a change of the class of service. It
  567. * is called to provision upgrade or downgrade orders, as well as being
  568. * able to be invoked manually by an admin user.
  569. *
  570. * This same function is called for upgrades and downgrades of both
  571. * products and configurable options.
  572. *
  573. * @param array $params common module parameters
  574. *
  575. * @see https://developers.whmcs.com/provisioning-modules/module-parameters/
  576. *
  577. * @return string 'success' or an error message
  578. */
  579. function zimbraSingle_ChangePackage($params) {
  580. $api = new Zm_Auth($params['serverhostname'], $params['serverusername'], $params['serverpassword'], 'admin');
  581. $login = $api->login();
  582. if(is_a($login, 'Exception')) {
  583. logModuleCall(
  584. 'zimbrasingle',
  585. __FUNCTION__,
  586. $params,
  587. 'Error: cannot login to ' . $params['serverhostname'],
  588. $login->getMessage()
  589. );
  590. return $login->getMessage();
  591. }
  592. $apiAccountManager = new Zm_Account($api);
  593. $response = $apiAccountManager->setAccountCos($params['username'], $params['configoption1']);
  594. if(is_a($response, 'Exception')) {
  595. logModuleCall(
  596. 'zimbrasingle',
  597. __FUNCTION__,
  598. $params,
  599. 'Error: could not set class of service for '. $params['username'],
  600. $response
  601. );
  602. return 'Error: could not set class of service for '. $params['username'];
  603. }
  604. $baseQuota = $params['configoption2'] ? $params['configoption2'] : 1;
  605. $addonQuota = $params['configoptions']['addonQuota'] ? $params['configoptions']['addonQuota'] : 0;
  606. $newAddQuota = $params['configoptions']['newAddQuota'] ? $params['configoptions']['newAddQuota'] : 0;
  607. $attrs['zimbraMailQuota'] = ($baseQuota + $addonQuota +$newAddQuota) * 1073741824;
  608. $response = $apiAccountManager->modifyAccount($params['username'], $attrs);
  609. if(is_a($response, 'Exception')) {
  610. logModuleCall(
  611. 'zimbrasingle',
  612. __FUNCTION__,
  613. $params,
  614. 'Error: could not update mailbox quota for '. $params['username'],
  615. $response
  616. );
  617. return 'Error: could not update mailbox quota for '. $params['username'];
  618. }
  619. try {
  620. Capsule::table('tblhosting')
  621. ->where('id', '=', $params['serviceid'])
  622. ->update(
  623. array(
  624. 'disklimit' => $attrs['zimbraMailQuota'],
  625. )
  626. );
  627. } catch (\Exception $e) {
  628. logModuleCall(
  629. 'zimbrasingle',
  630. __FUNCTION__,
  631. $params,
  632. 'Error: could not update quota in database',
  633. $e->getMessage()
  634. );
  635. return 'Error: could not update quota in database';
  636. }
  637. if(zimbraSingleUpdateQuota($params) != 'success') {
  638. return 'Error: could not update addonQuota in database';
  639. };
  640. return 'success';
  641. }
  642. /**
  643. * Define Zimbra product configuration options.
  644. *
  645. * Gather classes of service from the Zinbra server.
  646. * Calls a function to create all necessary customfields for the order form using the selected values.
  647. *
  648. * @see https://developers.whmcs.com/provisioning-modules/config-options/
  649. *
  650. * @return array
  651. */
  652. function zimbraSingle_ConfigOptions($params) {
  653. $whmcs = App::self();
  654. $serverGroupID = $whmcs->get_req_var('servergroup');
  655. $serverIDObj = Capsule::table('tblservergroupsrel')
  656. ->select('serverid')
  657. ->where('groupid', '=', $serverGroupID)
  658. ->get();
  659. $serverIDArray = zimbraSingleFindAll($serverIDObj,'serverid');
  660. $server = Capsule::table('tblservers')
  661. ->select('ipaddress', 'username', 'password')
  662. ->where('id', $serverIDArray)
  663. ->where('active', '=', 1)
  664. ->get();
  665. $accessData['zimbraServer'] = $server[0]->ipaddress;
  666. $accessData['adminUser'] = $server[0]->username;
  667. $passDecrypt = localAPI('DecryptPassword', array('password2' => $server[0]->password));
  668. if ($passDecrypt['result'] == 'success') {
  669. $accessData['adminPass'] = $passDecrypt['password'];
  670. } else {
  671. logModuleCall(
  672. 'zimbrasingle',
  673. __FUNCTION__,
  674. $server,
  675. 'Error: could not decrypt password',
  676. $passDecrypt['message']
  677. );
  678. return false;
  679. }
  680. $api = new Zm_Auth($accessData['zimbraServer'], $accessData['adminUser'], $accessData['adminPass'], 'admin');
  681. $login = $api->login();
  682. if(is_a($login, 'Exception')) {
  683. logModuleCall(
  684. 'zimbrasingle',
  685. __FUNCTION__,
  686. $server,
  687. 'Error: cannot login to ' . $accessData['zimbraServer'],
  688. $login->getMessage()
  689. );
  690. return false;
  691. }
  692. $apiAccountManager = new Zm_Account($api);
  693. $cosIDs = $apiAccountManager->getAllCos();
  694. if(is_a($cosIDs, 'Exception')) {
  695. logModuleCall(
  696. 'zimbrasingle',
  697. __FUNCTION__,
  698. $params,
  699. 'Error: could not fetch classes of service',
  700. $cosIDs
  701. );
  702. return false;
  703. }
  704. $cosNames = zimbraSingleFindAll($cosIDs, 'NAME');
  705. $configOptions = array();
  706. $configOptions['cos'] = array(
  707. 'FriendlyName' => 'Class of Service',
  708. 'Type' => 'dropdown',
  709. 'Options' => implode(',', $cosNames),
  710. 'Description' => 'Select COS',
  711. );
  712. $configOptions['quota'] = array(
  713. 'Type' => 'text',
  714. 'Description' => 'Basis Mailbox-Quota für dieses Produkt in GB',
  715. 'Default' => '5',
  716. 'Size' => '3',
  717. 'FriendlyName' => 'Mailbox Quota',
  718. );
  719. return $configOptions;
  720. }
  721. /**
  722. * Perform single sign-on for a given instance of a product/service.
  723. *
  724. * Called when single sign-on is requested for an instance of a product/service.
  725. *
  726. * When successful, returns an URL to which the user should be redirected.
  727. *
  728. * @param array $params common module parameters
  729. *
  730. * @see https://developers.whmcs.com/provisioning-modules/module-parameters/
  731. *
  732. * @return array
  733. */
  734. function zimbraSingle_ServiceSingleSignOn($params) {
  735. $api = new Zm_Auth($params['serverhostname'], $params['serverusername'], $params['serverpassword'], 'admin');
  736. $login = $api->login();
  737. if(is_a($login, 'Exception')) {
  738. logModuleCall(
  739. 'zimbrasingle',
  740. __FUNCTION__,
  741. $params,
  742. 'Error: cannot login to ' . $params['serverhostname'],
  743. $login->getMessage()
  744. );
  745. return array(
  746. 'success' => false,
  747. 'redirectTo' => '',
  748. );
  749. }
  750. $apiDomainManager = new Zm_Domain($api);
  751. $domainOptions = $apiDomainManager->getDomainOptions($params['customfields']['maildomain']);
  752. if(is_a($domainOptions, 'Exception')) {
  753. logModuleCall(
  754. 'zimbrasingle',
  755. __FUNCTION__,
  756. $params,
  757. 'Error : could not fetch options for ' . $params['customfields']['maildomain'],
  758. $domainOptions
  759. );
  760. return array(
  761. 'success' => false,
  762. 'redirectTo' => '',
  763. );
  764. }
  765. $preAuthKey = $domainOptions['zimbraPreAuthKey'];
  766. $apiAccountManager = new Zm_Account($api);
  767. $accountInfo = $apiAccountManager->getAccountInfo($params['username']);
  768. if(is_a($accountInfo, 'Exception')) {
  769. logModuleCall(
  770. 'zimbrasingle',
  771. __FUNCTION__,
  772. $params,
  773. 'Error: could not gather informations for ' . $params['username'],
  774. $accountInfo
  775. );
  776. return array(
  777. 'success' => false,
  778. 'redirectTo' => '',
  779. );
  780. }
  781. $webmailUrl = zimbraSingleFindAll($accountInfo, 'PUBLICMAILURL');
  782. $timestamp=time()*1000;
  783. $preauthToken=hash_hmac('sha1', $params['username'] . '|name|0|' . $timestamp, $preAuthKey);
  784. $preauthURL = $webmailUrl[0]['DATA'] . '/service/preauth?account=' . $params['username'] . '&by=name&timestamp=' . $timestamp .'&expires=0&preauth='. $preauthToken;
  785. return array(
  786. 'success' => true,
  787. 'redirectTo' => $preauthURL,
  788. );
  789. }
  790. function zimbraSingleUpdateQuota($params) {
  791. if(isset($params['configoptions']['addonQuota'])) {
  792. $addonQuota = $params['configoptions']['addonQuota'] ? $params['configoptions']['addonQuota'] : 0 ;
  793. $newAddQuota = $params['configoptions']['newAddQuota'] ? $params['configoptions']['newAddQuota'] : 0;
  794. $addonQuota = $addonQuota + $newAddQuota;
  795. $addonQuotaFieldIDObj = Capsule::table('tblproductconfigoptions')
  796. ->join('tblhostingconfigoptions', 'tblproductconfigoptions.id', '=', 'tblhostingconfigoptions.configid')
  797. ->where('tblhostingconfigoptions.relid', '=', $params['serviceid'])
  798. ->where('tblproductconfigoptions.optionname', 'like', 'addonQuota%')
  799. ->select('tblhostingconfigoptions.id')
  800. ->get();
  801. try {
  802. $updateAddonQuota = Capsule::table('tblhostingconfigoptions')
  803. ->where('id', $addonQuotaFieldIDObj[0]->id)
  804. ->update(
  805. [
  806. 'qty' => $addonQuota,
  807. ]
  808. );
  809. } catch (\Exception $e) {
  810. logModuleCall(
  811. 'zimbrasingle',
  812. __FUNCTION__,
  813. $updateAddonQuota,
  814. 'Error: could not save addonOuota in database.',
  815. $e->getMessage()
  816. );
  817. return 'Error: could not save addonOuota in database.';
  818. }
  819. $newAddQuotaFieldIDObj = Capsule::table('tblproductconfigoptions')
  820. ->join('tblhostingconfigoptions', 'tblproductconfigoptions.id', '=', 'tblhostingconfigoptions.configid')
  821. ->where('tblhostingconfigoptions.relid', '=', $params['serviceid'])
  822. ->where('tblproductconfigoptions.optionname', 'like', 'newAddQuota%')
  823. ->select('tblhostingconfigoptions.id')
  824. ->get();
  825. try {
  826. $updateNewAddQuota = Capsule::table('tblhostingconfigoptions')
  827. ->where('id', $newAddQuotaFieldIDObj[0]->id)
  828. ->update(
  829. [
  830. 'qty' => '0',
  831. ]
  832. );
  833. } catch (\Exception $e) {
  834. logModuleCall(
  835. 'zimbrasingle',
  836. __FUNCTION__,
  837. $updateNewAddQuota,
  838. 'Error: could not reset newAddOuota in database.',
  839. $e->getMessage()
  840. );
  841. return 'Error: could not reset newAddOuota in database.';
  842. }
  843. }
  844. return 'success';
  845. }