siteBuilder.php 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670
  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. return 'success';
  141. }
  142. /**
  143. * Removes a siteBuilder account.
  144. *
  145. * Called when a termination is requested. This can be invoked automatically for
  146. * overdue products if enabled, or requested manually by an admin user.
  147. *
  148. * @param array $params common module parameters
  149. *
  150. * @see https://developers.whmcs.com/provisioning-modules/supported-functions/
  151. *
  152. * @return string 'success' or an error message
  153. */
  154. function siteBuilder_TerminateAccount($params) {
  155. try {
  156. $active = Capsule::table('sitePro_acc')
  157. ->where('account',$params['username'])
  158. ->value('enabled');
  159. } catch (\Exception $e) {
  160. logModuleCall(
  161. 'siteBuilder',
  162. __FUNCTION__,
  163. $params,
  164. 'Error: could remove account from database',
  165. $e->getMessage()
  166. );
  167. return 'Error: could remove account from database';
  168. }
  169. if($active == true) {
  170. return 'Error: Account is active, please suspend account first';
  171. }
  172. try {
  173. Capsule::table('sitePro_site')
  174. ->where('relid',$params['serviceid'])
  175. ->delete();
  176. } catch (\Exception $e) {
  177. logModuleCall(
  178. 'siteBuilder',
  179. __FUNCTION__,
  180. $params,
  181. 'Error: could remove domains from database',
  182. $e->getMessage()
  183. );
  184. return 'Error: could remove domains from database';
  185. }
  186. try {
  187. Capsule::table('sitePro_acc')
  188. ->where('account',$params['username'])
  189. ->delete();
  190. } catch (\Exception $e) {
  191. logModuleCall(
  192. 'siteBuilder',
  193. __FUNCTION__,
  194. $params,
  195. 'Error: could remove account from database',
  196. $e->getMessage()
  197. );
  198. return 'Error: could remove account from database';
  199. }
  200. $siteBuilder = new ApiClient(getSiteBuilderApiURL($params), $params['serveraccesshash']);
  201. $response = $siteBuilder->terminate($params['domain'],$params['username']);
  202. if($response['status'] != '200') {
  203. return 'Error: ' . $response['response'];
  204. }
  205. return 'success';
  206. }
  207. /**
  208. * Set a siteBuilder account to status inactive.
  209. *
  210. * Called when a suspension is requested. This is invoked automatically by WHMCS
  211. * when a product becomes overdue on payment or can be called manually by admin
  212. * user.
  213. *
  214. * @param array $params common module parameters
  215. *
  216. * @see https://developers.whmcs.com/provisioning-modules/supported-functions/
  217. *
  218. * @return string 'success' or an error message
  219. */
  220. function siteBuilder_SuspendAccount($params) {
  221. $siteBuilder = new ApiClient(getSiteBuilderApiURL($params), $params['serveraccesshash']);
  222. $status = $siteBuilder->isprodenabled($params['domain'],$params['username']);
  223. if($status['status'] != '200') {
  224. return 'Error: ' . $status['error_msg'];
  225. }
  226. if($response['response']['isenabled'] == 'YES'){
  227. $response = $siteBuilder->disableprod($params['domain'],$params['username']);
  228. if($response['status'] != '200') {
  229. return 'Error: ' . $response['error_msg'];
  230. }
  231. }
  232. try {
  233. Capsule::table('sitePro_acc')
  234. ->where('account',$params['username'])
  235. ->update(array(
  236. 'enabled' => false,
  237. ));
  238. } catch (\Exception $e) {
  239. logModuleCall(
  240. 'siteBuilder',
  241. __FUNCTION__,
  242. $params,
  243. 'Error: could remove account from database',
  244. $e->getMessage()
  245. );
  246. return 'Error: could remove account from database';
  247. }
  248. return 'success';
  249. }
  250. /**
  251. * Set a siteBuilder account to status active.
  252. *
  253. * Called when an un-suspension is requested. This is invoked
  254. * automatically upon payment of an overdue invoice for a product, or
  255. * can be called manually by admin user.
  256. *
  257. * @param array $params common module parameters
  258. *
  259. * @see https://developers.whmcs.com/provisioning-modules/supported-functions/
  260. *
  261. * @return string 'success' or an error message
  262. */
  263. function siteBuilder_UnsuspendAccount($params) {
  264. try {
  265. Capsule::table('sitePro_acc')
  266. ->where('account',$params['username'])
  267. ->update(array(
  268. 'enabled' => true,
  269. ));
  270. } catch (\Exception $e) {
  271. logModuleCall(
  272. 'siteBuilder',
  273. __FUNCTION__,
  274. $params,
  275. 'Error: could remove account from database',
  276. $e->getMessage()
  277. );
  278. return 'Error: could remove account from database';
  279. }
  280. return 'success';
  281. }
  282. /**
  283. * Client area output logic handling.
  284. *
  285. * This function is used to define module specific client area output. It should
  286. * return an array consisting of a template file and optional additional
  287. * template variables to make available to that template.
  288. *
  289. * @param array $params common module parameters
  290. *
  291. * @see https://developers.whmcs.com/provisioning-modules/client-area-output/
  292. *
  293. * @return array
  294. */
  295. function siteBuilder_ClientArea($params) {
  296. $siteBuilder = new ApiClient(getSiteBuilderApiURL($params), $params['serveraccesshash']);
  297. $clientInfo = array('moduleclientarea' => '1');
  298. $clientInfo['domain'] = $params['domain'];
  299. $accountObj = Capsule::table('sitePro_acc')
  300. ->where('pid', $params['serviceid'])
  301. ->get();
  302. $sitesObj = Capsule::table('sitePro_site')
  303. ->where('relid', $params['serviceid'])
  304. ->get();
  305. $clientInfo['sites'] = [];
  306. $sslProd = 0;
  307. $sslDev = 0;
  308. foreach($sitesObj as $site){
  309. $response = $siteBuilder->getSSLDays($site->name, $params['username']);
  310. if($response['status'] == '200') {
  311. $sslProd = $response['response']['ssl_remaining'];
  312. }
  313. $response = $siteBuilder->getSSLDays('dev.' . $site->name, $params['username']);
  314. if($response['status'] == '200') {
  315. $sslDev = $response['response']['ssl_remaining'];
  316. }
  317. array_push($clientInfo['sites'],['name' => $site->name, 'sslProd' => $sslProd, 'sslDev' => $sslDev]);
  318. }
  319. return array(
  320. 'tabOverviewReplacementTemplate' => 'clientarea',
  321. 'vars' => $clientInfo,
  322. );
  323. }
  324. /**
  325. * Perform single sign-on for a siteBuilder account.
  326. *
  327. * When successful, returns a URL to which the user should be redirected.
  328. *
  329. * @param array $params common module parameters
  330. *
  331. * @see https://developers.whmcs.com/provisioning-modules/single-sign-on/
  332. *
  333. * @return array
  334. */
  335. function siteBuilder_ServiceSingleSignOn($params) {
  336. }
  337. /**
  338. * Upgrade or downgrade a siteBuilder account by package.
  339. *
  340. * Called to apply any change in product assignment or parameters. It
  341. * is called to provision upgrade or downgrade orders, as well as being
  342. * able to be invoked manually by an admin user.
  343. *
  344. * This same function is called for upgrades and downgrades of both
  345. * products and configurable options.
  346. *
  347. * @param array $params common module parameters
  348. *
  349. * @see https://developers.whmcs.com/provisioning-modules/supported-functions/
  350. *
  351. * @return string "success" or an error message
  352. */
  353. function siteBuilder_ChangePackage($params) {
  354. return 'success';
  355. }
  356. /**
  357. * Usage Update
  358. *
  359. * Important: Runs daily per server not per product
  360. * Run Manually: /admin/reports.php?report=disk_usage_summary&action=updatestats
  361. * @param array $params common module parameters
  362. *
  363. * @see https://developers.whmcs.com/provisioning-modules/usage-update/
  364. */
  365. function siteBuilder_UsageUpdate($params) {
  366. }
  367. /**
  368. * Additional actions a client user can invoke.
  369. *
  370. * Define additional actions a client user can perform for an instance of a
  371. * product/service.
  372. *
  373. * Any actions you define here will be automatically displayed in the available
  374. * list of actions within the client area.
  375. *
  376. * @return array
  377. */
  378. function siteBuilder_ClientAreaCustomButtonArray ($params) {
  379. return array(
  380. 'Neue Webseite' => 'newSite',
  381. );
  382. }
  383. /**
  384. * Additional actions a client user can invoke.
  385. *
  386. * Define additional actions a client user is allowed to perform for an instance of a
  387. * product/service.
  388. *
  389. * @see https://developers.whmcs.com/provisioning-modules/supported-functions/
  390. *
  391. * @return array
  392. */
  393. function siteBuilder_ClientAreaAllowedFunctions() {
  394. return array(
  395. "Add Site" => "addSite",
  396. "new Site" => "newSite",
  397. "Confirm Delete Site" => "delSiteConfirm",
  398. "Delete Site" => "delSite",
  399. "Edit Site" => "editSite",
  400. 'Conform Revert Site' => 'revSiteConfirm',
  401. 'Revert Site' => 'revSite',
  402. 'Publish Site' => 'pubSite',
  403. 'Activate Prod' => 'enableProd',
  404. 'Deactivate Prod' => 'disableProd'
  405. );
  406. }
  407. /**
  408. * Opens a form to add a new domain.
  409. *
  410. * @param array $params common module parameters
  411. *
  412. * @see https://developers.whmcs.com/provisioning-modules/supported-functions/
  413. *
  414. * @return array template information
  415. */
  416. function siteBuilder_newSite($params) {
  417. return array(
  418. 'breadcrumb' => array(
  419. 'clientarea.php?action=productdetails&id=' . $params['serviceid'] . '&modop=custom&a=newSite' => 'Neue Webseite',
  420. ),
  421. 'templatefile' => 'siteBuilder_new_site',
  422. );
  423. }
  424. /**
  425. * Adds a new domain to a siteBuilder account.
  426. *
  427. * @param array $params common module parameters
  428. *
  429. * @see https://developers.whmcs.com/provisioning-modules/supported-functions/
  430. *
  431. * @return string "success" or an error message
  432. */
  433. function siteBuilder_addSite($params) {
  434. if(!filter_var($_POST['d'], FILTER_VALIDATE_DOMAIN, FILTER_FLAG_HOSTNAME)){
  435. return 'Error: invalid site name';
  436. }
  437. $site = $_POST['d'] . '.' . $params['domain'];
  438. $siteBuilder = new ApiClient(getSiteBuilderApiURL($params), $params['serveraccesshash']);
  439. $response = $siteBuilder->deployDev($params['username'], $site, $params['serverusername'], $params['serverpassword']);
  440. if($response['status'] != '200') {
  441. return 'Error: ' . $response['response'];
  442. }
  443. try {
  444. Capsule::table('sitePro_site')
  445. ->insert(
  446. array(
  447. 'relid' => $params['serviceid'],
  448. 'name' => $site,
  449. 'enabled' => false,
  450. )
  451. );
  452. } catch (\Exception $e) {
  453. logModuleCall(
  454. 'siteBuilder',
  455. __FUNCTION__,
  456. $params,
  457. 'Error: could save site & serviceid in database',
  458. $e->getMessage()
  459. );
  460. return 'Error: could save site & serviceid in database';
  461. }
  462. return 'success';
  463. }
  464. function siteBuilder_editSite($params) {
  465. if(!filter_var($_POST['s'], FILTER_VALIDATE_DOMAIN, FILTER_FLAG_HOSTNAME)){
  466. return 'Error: invalid site name';
  467. }
  468. $site = $_POST['s'];
  469. $api = new SiteProApiClient('https://builder.thurdata.ch/api/', 'apikey0', '993yVHwC05TLsx2JI2XFlAhkkPUxR6JbQUYbI.a5HiRtmNV9');
  470. // use this for enterprise licenses and change 'your-bulder-domain.com' to your builder domain
  471. //$api = new SiteProApiClient('http://your-bulder-domain.com/api/', 'your_api_username', 'your_api_password');
  472. try {
  473. // this call is used to open builder, so you need to set correct parameters to represent users website you want to open
  474. // this data usually comes from your user/hosting manager system
  475. $res = $api->remoteCall('requestLogin', array(
  476. 'type' => 'internal', // (required) 'internal'
  477. 'domain' => $site, // (required) domain of the user website you want to edit
  478. 'lang' => 'de', // (optional) 2-letter language code, set language code you whant builder to open in
  479. 'apiUrl' => '/deployDev', // (required) API endpoint URL
  480. 'resellerClientAccountId' => $params['serviceid'], // (required) ID of website/user in your system
  481. // 'username' => 'example_user', // (optional) authorization username to be used with API endpoint
  482. // 'password' => 'example_password', // (optional) authorization password to be used with API endpoint
  483. ));
  484. if (!$res || !is_object($res)) {
  485. logModuleCall(
  486. 'siteBuilder',
  487. __FUNCTION__,
  488. $params,
  489. 'Error: Response format error',
  490. $res
  491. );
  492. return 'Error: Response format error';
  493. } else if (isset($res->url) && $res->url) {
  494. logModuleCall(
  495. 'siteBuilder',
  496. __FUNCTION__,
  497. $params,
  498. 'Debug',
  499. $res
  500. );
  501. // on success redirect to builder URL
  502. // header('Location: '.$res->url, true);
  503. // exit();
  504. } else {
  505. logModuleCall(
  506. 'siteBuilder',
  507. __FUNCTION__,
  508. $params,
  509. 'Error: Unknown error',
  510. $res
  511. );
  512. return 'Error: Unknown error';
  513. }
  514. } catch (\Exception $e) {
  515. logModuleCall(
  516. 'siteBuilder',
  517. __FUNCTION__,
  518. $params,
  519. 'Error: Request error',
  520. $e->getMessage()
  521. );
  522. return 'Error: Request error';
  523. }
  524. return 'success';
  525. }
  526. /**
  527. * Opens a form to delete a domain from a siteBuilder account.
  528. *
  529. * @param array $params common module parameters
  530. *
  531. * @see https://developers.whmcs.com/provisioning-modules/supported-functions/
  532. *
  533. * @return array template information
  534. */
  535. function siteBuilder_delSiteConfirm($params) {
  536. return array(
  537. 'templatefile' => 'siteBuilder_del_site_confirm',
  538. 'vars' => array(
  539. 'delsite' => $_POST['s'],
  540. ),
  541. );
  542. }
  543. /**
  544. * Removes a domain from a siteBuilder account.
  545. *
  546. * @param array $params common module parameters
  547. *
  548. * @see https://developers.whmcs.com/provisioning-modules/supported-functions/
  549. *
  550. * @return string "success" or an error message
  551. */
  552. function siteBuilder_delSite($params) {
  553. if(!filter_var($_POST['d'], FILTER_VALIDATE_DOMAIN, FILTER_FLAG_HOSTNAME)){
  554. return 'Error: invalid domain name';
  555. }
  556. return 'success';
  557. }
  558. /**
  559. * Opens a form to delete a domain from a siteBuilder account.
  560. *
  561. * @param array $params common module parameters
  562. *
  563. * @see https://developers.whmcs.com/provisioning-modules/supported-functions/
  564. *
  565. * @return array template information
  566. */
  567. function siteBuilder_revSiteConfirm($params) {
  568. return array(
  569. 'templatefile' => 'siteBuilder_rev_site_confirm',
  570. 'vars' => array(
  571. 'delSite' => $_POST['s'],
  572. ),
  573. );
  574. }
  575. /**
  576. * Revert all Changes of the development Site.
  577. *
  578. * @param array $params common module parameters
  579. *
  580. * @see https://developers.whmcs.com/provisioning-modules/supported-functions/
  581. *
  582. * @return string "success" or an error message
  583. */
  584. function siteBuilder_revSite($params) {
  585. if(!filter_var($_POST['s'], FILTER_VALIDATE_DOMAIN, FILTER_FLAG_HOSTNAME)){
  586. return 'Error: invalid site name';
  587. }
  588. $site = $_POST['s'];
  589. $siteBuilder = new ApiClient(getSiteBuilderApiURL($params), $params['serveraccesshash']);
  590. $response = $siteBuilder->revertDev($params['username'], $site, $params['serverusername'], $params['serverpassword']);
  591. if($response['status'] != '200') {
  592. return 'Error: ' . $response['response'];
  593. }
  594. return 'success';
  595. }
  596. /**
  597. * Returns API Url .
  598. *
  599. * @param string $params common module parameters
  600. * @param string $user
  601. * @param string $params common module parameters
  602. *
  603. * @return string $apiUrl
  604. */
  605. function getSiteBuilderApiURL($params) {
  606. $httpPrefix = $params['serversecure'] ? 'https://' : 'http://';
  607. $serverPort = $params['serverport'] ? ':' . $params['serverport'] . '/' : '/';
  608. return $httpPrefix . $params['serverhostname'] . $serverPort;
  609. }
  610. function siteBuilderCreateTables() {
  611. // Create a new table.
  612. if (!Capsule::schema()->hasTable('sitePro_acc')) {
  613. try {
  614. Capsule::schema()->create(
  615. 'sitePro_acc',
  616. function ($table) {
  617. /** @var \Illuminate\Database\Schema\Blueprint $table */
  618. $table->increments('id');
  619. $table->string('account');
  620. $table->integer('pid');
  621. $table->boolean('enabled');
  622. }
  623. );
  624. } catch (\Exception $e) {
  625. echo "Unable to create sitePro_acc: {$e->getMessage()}";
  626. }
  627. }
  628. if (!Capsule::schema()->hasTable('sitePro_site')) {
  629. try {
  630. Capsule::schema()->create(
  631. 'sitePro_site',
  632. function ($table) {
  633. /** @var \Illuminate\Database\Schema\Blueprint $table */
  634. $table->increments('id');
  635. $table->integer('relid');
  636. $table->string('name');
  637. $table->boolean('enabled');
  638. }
  639. );
  640. } catch (\Exception $e) {
  641. echo "Unable to create sitePro_site: {$e->getMessage()}";
  642. }
  643. }
  644. }