siteBuilder.php 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674
  1. <?php
  2. /**
  3. * WHMCS siteBuilder Provisioning Module
  4. *
  5. * Provisioning for User Account on the siteBuilder Server
  6. *
  7. * @see https://centos-webpanel.com/
  8. * @copyright Copyright (c) Thurdata GmbH 2022
  9. * @license GPL
  10. */
  11. use WHMCS\Database\Capsule;
  12. require_once 'Net/DNS2.php';
  13. require_once(__DIR__ . '/api/sitebuilder.php');
  14. require_once(__DIR__ . '/api/SiteProApiClient.php');
  15. if (!defined('WHMCS')) {
  16. die('This file cannot be accessed directly');
  17. }
  18. /**
  19. * Define siteBuilder product metadata parameters.
  20. *
  21. * @see https://developers.whmcs.com/provisioning-modules/meta-data-params/
  22. *
  23. * @return array
  24. */
  25. function siteBuilder_MetaData() {
  26. return array(
  27. 'DisplayName' => 'ThurData SiteBuilder Provisioning',
  28. 'APIVersion' => '1.2',
  29. 'DefaultNonSSLPort' => '80',
  30. 'DefaultSSLPort' => '443',
  31. 'RequiresServer' => true,
  32. 'ServiceSingleSignOnLabel' => 'Login to siteBuilder',
  33. 'AdminSingleSignOnLabel' => 'Login to siteBuilder Admin'
  34. );
  35. }
  36. function siteBuilder_ConfigOptions() {
  37. siteBuilderCreateTables();
  38. return ["BuilderURL" => [
  39. "FriendlyName" => "Builder URL", # Full Builder URL (prefix//hostname:port/)
  40. "Type" => "text", # Text Box
  41. "Size" => "25", # Defines the Field Width
  42. "Description" => "Full Builder URL (prefix//hostname:port/)",
  43. "Default" => "https://builder.thurdata.ch/",
  44. ],
  45. ];
  46. }
  47. /**
  48. * Test connection to a siteBuilder server with the given server parameters.
  49. *
  50. * Allows an admin user to verify that an API connection can be
  51. * successfully made with the given configuration parameters for a
  52. * server.
  53. *
  54. * When defined in a module, a test connection button will appear
  55. * alongside the server type dropdown when adding or editing an
  56. * existing server.
  57. *
  58. * @param array $params common module parameters
  59. *
  60. * @see https://developers.whmcs.com/provisioning-modules/module-parameters/
  61. *
  62. * @return array
  63. */
  64. function siteBuilder_Testconnection($params) {
  65. $siteBuilder = new ApiClient(getSiteBuilderApiURL($params), $params['serveraccesshash']);
  66. $response = $siteBuilder->ping($params['serverusername'], $params['serverpassword']);
  67. if($response['response']['answer'] == 'pong') {
  68. return array(
  69. 'success' => true,
  70. 'error' => '',
  71. );
  72. }
  73. return array(
  74. 'success' => false,
  75. 'error' => $response,
  76. );
  77. }
  78. /**
  79. * Provision a new account of a siteBuilder server.
  80. *
  81. * Attempt to provision a new siteBuilder account. This is
  82. * called any time provisioning is requested inside of WHMCS. Depending upon the
  83. * configuration, this can be any of:
  84. * * When a new order is placed
  85. * * When an invoice for a new order is paid
  86. * * Upon manual request by an admin user
  87. *
  88. * @param array $params common module parameters
  89. *
  90. * @see https://developers.whmcs.com/provisioning-modules/supported-functions/
  91. *
  92. * @return string 'success' or an error message
  93. */
  94. function siteBuilder_CreateAccount($params) {
  95. $username = strtolower(substr($params['clientsdetails']['firstname'],0,2) . substr($params['clientsdetails']['lastname'],0,3)) . $params['serviceid'];
  96. $userdomain = $params['domain'];
  97. try {
  98. Capsule::table('tblhosting')
  99. ->where('id', '=', $params['serviceid'])
  100. ->update(
  101. array(
  102. 'username' => $username,
  103. 'domain' => $userdomain,
  104. )
  105. );
  106. } catch (\Exception $e) {
  107. logModuleCall(
  108. 'siteBuilder',
  109. __FUNCTION__,
  110. $params,
  111. 'Error: could save username & domain in database',
  112. $e->getMessage()
  113. );
  114. return 'Error: could save username & password in database';
  115. }
  116. try {
  117. Capsule::table('sitePro_acc')
  118. ->insert(
  119. array(
  120. 'account' => $username,
  121. 'pid' => $params['serviceid'],
  122. 'enabled' => true,
  123. )
  124. );
  125. } catch (\Exception $e) {
  126. logModuleCall(
  127. 'siteBuilder',
  128. __FUNCTION__,
  129. $params,
  130. 'Error: could save username & serviceid in database',
  131. $e->getMessage()
  132. );
  133. return 'Error: could save username & serviceid in database';
  134. }
  135. $siteBuilder = new ApiClient(getSiteBuilderApiURL($params), $params['serveraccesshash']);
  136. $response = $siteBuilder->create($params['domain'],$params['username'], $params['serverusername'], $params['serverpassword']);
  137. if($response['status'] != '200') {
  138. return 'Error: ' . $response['response'];
  139. }
  140. $response = $siteBuilder->init($params['domain'],$params['username'], $params['serverusername'], $params['serverpassword']);
  141. if($response['status'] != '200') {
  142. return 'Error: ' . $response['response'];
  143. }
  144. return 'success';
  145. }
  146. /**
  147. * Removes a siteBuilder account.
  148. *
  149. * Called when a termination is requested. This can be invoked automatically for
  150. * overdue products if enabled, or requested manually by an admin user.
  151. *
  152. * @param array $params common module parameters
  153. *
  154. * @see https://developers.whmcs.com/provisioning-modules/supported-functions/
  155. *
  156. * @return string 'success' or an error message
  157. */
  158. function siteBuilder_TerminateAccount($params) {
  159. try {
  160. $active = Capsule::table('sitePro_acc')
  161. ->where('account',$params['username'])
  162. ->value('enabled');
  163. } catch (\Exception $e) {
  164. logModuleCall(
  165. 'siteBuilder',
  166. __FUNCTION__,
  167. $params,
  168. 'Error: could find account in database',
  169. $e->getMessage()
  170. );
  171. return 'Error: could remove account from database';
  172. }
  173. if($active == true) {
  174. return 'Error: Account is active, please suspend account first';
  175. }
  176. try {
  177. Capsule::table('sitePro_site')
  178. ->where('relid',$params['serviceid'])
  179. ->delete();
  180. } catch (\Exception $e) {
  181. logModuleCall(
  182. 'siteBuilder',
  183. __FUNCTION__,
  184. $params,
  185. 'Error: could remove domains from database',
  186. $e->getMessage()
  187. );
  188. return 'Error: could remove domains from database';
  189. }
  190. try {
  191. Capsule::table('sitePro_acc')
  192. ->where('account',$params['username'])
  193. ->delete();
  194. } catch (\Exception $e) {
  195. logModuleCall(
  196. 'siteBuilder',
  197. __FUNCTION__,
  198. $params,
  199. 'Error: could remove account from database',
  200. $e->getMessage()
  201. );
  202. return 'Error: could remove account from database';
  203. }
  204. $siteBuilder = new ApiClient(getSiteBuilderApiURL($params), $params['serveraccesshash']);
  205. $response = $siteBuilder->terminate($params['domain'],$params['username']);
  206. if($response['status'] != '200') {
  207. return 'Error: ' . $response['response'];
  208. }
  209. return 'success';
  210. }
  211. /**
  212. * Set a siteBuilder account to status inactive.
  213. *
  214. * Called when a suspension is requested. This is invoked automatically by WHMCS
  215. * when a product becomes overdue on payment or can be called manually by admin
  216. * user.
  217. *
  218. * @param array $params common module parameters
  219. *
  220. * @see https://developers.whmcs.com/provisioning-modules/supported-functions/
  221. *
  222. * @return string 'success' or an error message
  223. */
  224. function siteBuilder_SuspendAccount($params) {
  225. $siteBuilder = new ApiClient(getSiteBuilderApiURL($params), $params['serveraccesshash']);
  226. $status = $siteBuilder->isprodenabled($params['domain'],$params['username']);
  227. if($status['status'] != '200') {
  228. return 'Error: ' . $status['error_msg'];
  229. }
  230. if($response['response']['isenabled'] == 'YES'){
  231. $response = $siteBuilder->disableprod($params['domain'],$params['username']);
  232. if($response['status'] != '200') {
  233. return 'Error: ' . $response['error_msg'];
  234. }
  235. }
  236. try {
  237. Capsule::table('sitePro_acc')
  238. ->where('account',$params['username'])
  239. ->update(array(
  240. 'enabled' => false,
  241. ));
  242. } catch (\Exception $e) {
  243. logModuleCall(
  244. 'siteBuilder',
  245. __FUNCTION__,
  246. $params,
  247. 'Error: could not disable account in database',
  248. $e->getMessage()
  249. );
  250. return 'Error: could not disable account in database';
  251. }
  252. return 'success';
  253. }
  254. /**
  255. * Set a siteBuilder account to status active.
  256. *
  257. * Called when an un-suspension is requested. This is invoked
  258. * automatically upon payment of an overdue invoice for a product, or
  259. * can be called manually by admin user.
  260. *
  261. * @param array $params common module parameters
  262. *
  263. * @see https://developers.whmcs.com/provisioning-modules/supported-functions/
  264. *
  265. * @return string 'success' or an error message
  266. */
  267. function siteBuilder_UnsuspendAccount($params) {
  268. try {
  269. Capsule::table('sitePro_acc')
  270. ->where('account',$params['username'])
  271. ->update(array(
  272. 'enabled' => true,
  273. ));
  274. } catch (\Exception $e) {
  275. logModuleCall(
  276. 'siteBuilder',
  277. __FUNCTION__,
  278. $params,
  279. 'Error: could remove account from database',
  280. $e->getMessage()
  281. );
  282. return 'Error: could remove account from database';
  283. }
  284. return 'success';
  285. }
  286. /**
  287. * Client area output logic handling.
  288. *
  289. * This function is used to define module specific client area output. It should
  290. * return an array consisting of a template file and optional additional
  291. * template variables to make available to that template.
  292. *
  293. * @param array $params common module parameters
  294. *
  295. * @see https://developers.whmcs.com/provisioning-modules/client-area-output/
  296. *
  297. * @return array
  298. */
  299. function siteBuilder_ClientArea($params) {
  300. $siteBuilder = new ApiClient(getSiteBuilderApiURL($params), $params['serveraccesshash']);
  301. $clientInfo = array('moduleclientarea' => '1');
  302. $clientInfo['domain'] = $params['domain'];
  303. $accountObj = Capsule::table('sitePro_acc')
  304. ->where('pid', $params['serviceid'])
  305. ->get();
  306. $sitesObj = Capsule::table('sitePro_site')
  307. ->where('relid', $params['serviceid'])
  308. ->get();
  309. $clientInfo['sites'] = [];
  310. $sslProd = 0;
  311. $sslDev = 0;
  312. foreach($sitesObj as $site){
  313. $response = $siteBuilder->getSSLDays($site->name, $params['username']);
  314. if($response['status'] == '200') {
  315. $sslProd = $response['response']['ssl_remaining'];
  316. }
  317. $response = $siteBuilder->getSSLDays('dev.' . $site->name, $params['username']);
  318. if($response['status'] == '200') {
  319. $sslDev = $response['response']['ssl_remaining'];
  320. }
  321. array_push($clientInfo['sites'],['name' => $site->name, 'sslProd' => $sslProd, 'sslDev' => $sslDev]);
  322. }
  323. return array(
  324. 'tabOverviewReplacementTemplate' => 'clientarea',
  325. 'vars' => $clientInfo,
  326. );
  327. }
  328. /**
  329. * Perform single sign-on for a siteBuilder account.
  330. *
  331. * When successful, returns a URL to which the user should be redirected.
  332. *
  333. * @param array $params common module parameters
  334. *
  335. * @see https://developers.whmcs.com/provisioning-modules/single-sign-on/
  336. *
  337. * @return array
  338. */
  339. function siteBuilder_ServiceSingleSignOn($params) {
  340. }
  341. /**
  342. * Upgrade or downgrade a siteBuilder account by package.
  343. *
  344. * Called to apply any change in product assignment or parameters. It
  345. * is called to provision upgrade or downgrade orders, as well as being
  346. * able to be invoked manually by an admin user.
  347. *
  348. * This same function is called for upgrades and downgrades of both
  349. * products and configurable options.
  350. *
  351. * @param array $params common module parameters
  352. *
  353. * @see https://developers.whmcs.com/provisioning-modules/supported-functions/
  354. *
  355. * @return string "success" or an error message
  356. */
  357. function siteBuilder_ChangePackage($params) {
  358. return 'success';
  359. }
  360. /**
  361. * Usage Update
  362. *
  363. * Important: Runs daily per server not per product
  364. * Run Manually: /admin/reports.php?report=disk_usage_summary&action=updatestats
  365. * @param array $params common module parameters
  366. *
  367. * @see https://developers.whmcs.com/provisioning-modules/usage-update/
  368. */
  369. function siteBuilder_UsageUpdate($params) {
  370. }
  371. /**
  372. * Additional actions a client user can invoke.
  373. *
  374. * Define additional actions a client user can perform for an instance of a
  375. * product/service.
  376. *
  377. * Any actions you define here will be automatically displayed in the available
  378. * list of actions within the client area.
  379. *
  380. * @return array
  381. */
  382. function siteBuilder_ClientAreaCustomButtonArray ($params) {
  383. return array(
  384. 'Neue Webseite' => 'newSite',
  385. );
  386. }
  387. /**
  388. * Additional actions a client user can invoke.
  389. *
  390. * Define additional actions a client user is allowed to perform for an instance of a
  391. * product/service.
  392. *
  393. * @see https://developers.whmcs.com/provisioning-modules/supported-functions/
  394. *
  395. * @return array
  396. */
  397. function siteBuilder_ClientAreaAllowedFunctions() {
  398. return array(
  399. "Add Site" => "addSite",
  400. "new Site" => "newSite",
  401. "Confirm Delete Site" => "delSiteConfirm",
  402. "Delete Site" => "delSite",
  403. "Edit Site" => "editSite",
  404. 'Conform Revert Site' => 'revSiteConfirm',
  405. 'Revert Site' => 'revSite',
  406. 'Publish Site' => 'pubSite',
  407. 'Activate Prod' => 'enableProd',
  408. 'Deactivate Prod' => 'disableProd'
  409. );
  410. }
  411. /**
  412. * Opens a form to add a new domain.
  413. *
  414. * @param array $params common module parameters
  415. *
  416. * @see https://developers.whmcs.com/provisioning-modules/supported-functions/
  417. *
  418. * @return array template information
  419. */
  420. function siteBuilder_newSite($params) {
  421. return array(
  422. 'breadcrumb' => array(
  423. 'clientarea.php?action=productdetails&id=' . $params['serviceid'] . '&modop=custom&a=newSite' => 'Neue Webseite',
  424. ),
  425. 'templatefile' => 'siteBuilder_new_site',
  426. );
  427. }
  428. /**
  429. * Adds a new domain to a siteBuilder account.
  430. *
  431. * @param array $params common module parameters
  432. *
  433. * @see https://developers.whmcs.com/provisioning-modules/supported-functions/
  434. *
  435. * @return string "success" or an error message
  436. */
  437. function siteBuilder_addSite($params) {
  438. if(!filter_var($_POST['d'], FILTER_VALIDATE_DOMAIN, FILTER_FLAG_HOSTNAME)){
  439. return 'Error: invalid site name';
  440. }
  441. $site = $_POST['d'] . '.' . $params['domain'];
  442. $siteBuilder = new ApiClient(getSiteBuilderApiURL($params), $params['serveraccesshash']);
  443. $response = $siteBuilder->deployDev($params['username'], $site, $params['serverusername'], $params['serverpassword']);
  444. if($response['status'] != '200') {
  445. return 'Error: ' . $response['response'];
  446. }
  447. try {
  448. Capsule::table('sitePro_site')
  449. ->insert(
  450. array(
  451. 'relid' => $params['serviceid'],
  452. 'name' => $site,
  453. 'enabled' => false,
  454. )
  455. );
  456. } catch (\Exception $e) {
  457. logModuleCall(
  458. 'siteBuilder',
  459. __FUNCTION__,
  460. $params,
  461. 'Error: could save site & serviceid in database',
  462. $e->getMessage()
  463. );
  464. return 'Error: could save site & serviceid in database';
  465. }
  466. return 'success';
  467. }
  468. function siteBuilder_editSite($params) {
  469. if(!filter_var($_POST['s'], FILTER_VALIDATE_DOMAIN, FILTER_FLAG_HOSTNAME)){
  470. return 'Error: invalid site name';
  471. }
  472. $site = $_POST['s'];
  473. $api = new SiteProApiClient('https://builder.thurdata.ch/api/', 'apikey0', '993yVHwC05TLsx2JI2XFlAhkkPUxR6JbQUYbI.a5HiRtmNV9');
  474. // use this for enterprise licenses and change 'your-bulder-domain.com' to your builder domain
  475. //$api = new SiteProApiClient('http://your-bulder-domain.com/api/', 'your_api_username', 'your_api_password');
  476. try {
  477. // this call is used to open builder, so you need to set correct parameters to represent users website you want to open
  478. // this data usually comes from your user/hosting manager system
  479. $res = $api->remoteCall('requestLogin', array(
  480. 'type' => 'internal', // (required) 'internal'
  481. 'domain' => $site, // (required) domain of the user website you want to edit
  482. 'lang' => 'de', // (optional) 2-letter language code, set language code you whant builder to open in
  483. 'apiUrl' => '/deployDev', // (required) API endpoint URL
  484. 'resellerClientAccountId' => $params['serviceid'], // (required) ID of website/user in your system
  485. // 'username' => 'example_user', // (optional) authorization username to be used with API endpoint
  486. // 'password' => 'example_password', // (optional) authorization password to be used with API endpoint
  487. ));
  488. if (!$res || !is_object($res)) {
  489. logModuleCall(
  490. 'siteBuilder',
  491. __FUNCTION__,
  492. $params,
  493. 'Error: Response format error',
  494. $res
  495. );
  496. return 'Error: Response format error';
  497. } else if (isset($res->url) && $res->url) {
  498. logModuleCall(
  499. 'siteBuilder',
  500. __FUNCTION__,
  501. $params,
  502. 'Debug',
  503. $res
  504. );
  505. // on success redirect to builder URL
  506. // header('Location: '.$res->url, true);
  507. // exit();
  508. } else {
  509. logModuleCall(
  510. 'siteBuilder',
  511. __FUNCTION__,
  512. $params,
  513. 'Error: Unknown error',
  514. $res
  515. );
  516. return 'Error: Unknown error';
  517. }
  518. } catch (\Exception $e) {
  519. logModuleCall(
  520. 'siteBuilder',
  521. __FUNCTION__,
  522. $params,
  523. 'Error: Request error',
  524. $e->getMessage()
  525. );
  526. return 'Error: Request error';
  527. }
  528. return 'success';
  529. }
  530. /**
  531. * Opens a form to delete a domain from a siteBuilder account.
  532. *
  533. * @param array $params common module parameters
  534. *
  535. * @see https://developers.whmcs.com/provisioning-modules/supported-functions/
  536. *
  537. * @return array template information
  538. */
  539. function siteBuilder_delSiteConfirm($params) {
  540. return array(
  541. 'templatefile' => 'siteBuilder_del_site_confirm',
  542. 'vars' => array(
  543. 'delsite' => $_POST['s'],
  544. ),
  545. );
  546. }
  547. /**
  548. * Removes a domain from a siteBuilder account.
  549. *
  550. * @param array $params common module parameters
  551. *
  552. * @see https://developers.whmcs.com/provisioning-modules/supported-functions/
  553. *
  554. * @return string "success" or an error message
  555. */
  556. function siteBuilder_delSite($params) {
  557. if(!filter_var($_POST['d'], FILTER_VALIDATE_DOMAIN, FILTER_FLAG_HOSTNAME)){
  558. return 'Error: invalid domain name';
  559. }
  560. return 'success';
  561. }
  562. /**
  563. * Opens a form to delete a domain from a siteBuilder account.
  564. *
  565. * @param array $params common module parameters
  566. *
  567. * @see https://developers.whmcs.com/provisioning-modules/supported-functions/
  568. *
  569. * @return array template information
  570. */
  571. function siteBuilder_revSiteConfirm($params) {
  572. return array(
  573. 'templatefile' => 'siteBuilder_rev_site_confirm',
  574. 'vars' => array(
  575. 'delSite' => $_POST['s'],
  576. ),
  577. );
  578. }
  579. /**
  580. * Revert all Changes of the development Site.
  581. *
  582. * @param array $params common module parameters
  583. *
  584. * @see https://developers.whmcs.com/provisioning-modules/supported-functions/
  585. *
  586. * @return string "success" or an error message
  587. */
  588. function siteBuilder_revSite($params) {
  589. if(!filter_var($_POST['s'], FILTER_VALIDATE_DOMAIN, FILTER_FLAG_HOSTNAME)){
  590. return 'Error: invalid site name';
  591. }
  592. $site = $_POST['s'];
  593. $siteBuilder = new ApiClient(getSiteBuilderApiURL($params), $params['serveraccesshash']);
  594. $response = $siteBuilder->revertDev($params['username'], $site, $params['serverusername'], $params['serverpassword']);
  595. if($response['status'] != '200') {
  596. return 'Error: ' . $response['response'];
  597. }
  598. return 'success';
  599. }
  600. /**
  601. * Returns API Url .
  602. *
  603. * @param string $params common module parameters
  604. * @param string $user
  605. * @param string $params common module parameters
  606. *
  607. * @return string $apiUrl
  608. */
  609. function getSiteBuilderApiURL($params) {
  610. $httpPrefix = $params['serversecure'] ? 'https://' : 'http://';
  611. $serverPort = $params['serverport'] ? ':' . $params['serverport'] . '/' : '/';
  612. return $httpPrefix . $params['serverhostname'] . $serverPort;
  613. }
  614. function siteBuilderCreateTables() {
  615. // Create a new table.
  616. if (!Capsule::schema()->hasTable('sitePro_acc')) {
  617. try {
  618. Capsule::schema()->create(
  619. 'sitePro_acc',
  620. function ($table) {
  621. /** @var \Illuminate\Database\Schema\Blueprint $table */
  622. $table->increments('id');
  623. $table->string('account');
  624. $table->integer('pid');
  625. $table->boolean('enabled');
  626. }
  627. );
  628. } catch (\Exception $e) {
  629. echo "Unable to create sitePro_acc: {$e->getMessage()}";
  630. }
  631. }
  632. if (!Capsule::schema()->hasTable('sitePro_site')) {
  633. try {
  634. Capsule::schema()->create(
  635. 'sitePro_site',
  636. function ($table) {
  637. /** @var \Illuminate\Database\Schema\Blueprint $table */
  638. $table->increments('id');
  639. $table->integer('relid');
  640. $table->string('name');
  641. $table->boolean('enabled');
  642. }
  643. );
  644. } catch (\Exception $e) {
  645. echo "Unable to create sitePro_site: {$e->getMessage()}";
  646. }
  647. }
  648. }