siteBuilder.php 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560
  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. if (!defined('WHMCS')) {
  15. die('This file cannot be accessed directly');
  16. }
  17. /**
  18. * Define siteBuilder product metadata parameters.
  19. *
  20. * @see https://developers.whmcs.com/provisioning-modules/meta-data-params/
  21. *
  22. * @return array
  23. */
  24. function siteBuilder_MetaData() {
  25. return array(
  26. 'DisplayName' => 'ThurData SiteBuilder Provisioning',
  27. 'APIVersion' => '1.2',
  28. 'DefaultNonSSLPort' => '80',
  29. 'DefaultSSLPort' => '443',
  30. 'RequiresServer' => true,
  31. 'ServiceSingleSignOnLabel' => 'Login to siteBuilder',
  32. 'AdminSingleSignOnLabel' => 'Login to siteBuilder Admin'
  33. );
  34. }
  35. function siteBuilder_ConfigOptions() {
  36. siteBuilderCreateTables();
  37. return ["BuilderURL" => [
  38. "FriendlyName" => "Builder URL", # Full Builder URL (prefix//hostname:port/)
  39. "Type" => "text", # Text Box
  40. "Size" => "25", # Defines the Field Width
  41. "Description" => "Full Builder URL (prefix//hostname:port/)",
  42. "Default" => "https://builder.thurdata.ch/",
  43. ],
  44. ];
  45. }
  46. /**
  47. * Test connection to a siteBuilder server with the given server parameters.
  48. *
  49. * Allows an admin user to verify that an API connection can be
  50. * successfully made with the given configuration parameters for a
  51. * server.
  52. *
  53. * When defined in a module, a test connection button will appear
  54. * alongside the server type dropdown when adding or editing an
  55. * existing server.
  56. *
  57. * @param array $params common module parameters
  58. *
  59. * @see https://developers.whmcs.com/provisioning-modules/module-parameters/
  60. *
  61. * @return array
  62. */
  63. function siteBuilder_Testconnection($params) {
  64. $siteBuilder = new ApiClient(getSiteBuilderApiURL($params), $params['serveraccesshash']);
  65. $response = $siteBuilder->ping($params['serverusername'], $params['serverpassword']);
  66. if($response['response']['answer'] == 'pong') {
  67. return array(
  68. 'success' => true,
  69. 'error' => '',
  70. );
  71. }
  72. return array(
  73. 'success' => false,
  74. 'error' => $response,
  75. );
  76. }
  77. /**
  78. * Provision a new account of a siteBuilder server.
  79. *
  80. * Attempt to provision a new siteBuilder account. This is
  81. * called any time provisioning is requested inside of WHMCS. Depending upon the
  82. * configuration, this can be any of:
  83. * * When a new order is placed
  84. * * When an invoice for a new order is paid
  85. * * Upon manual request by an admin user
  86. *
  87. * @param array $params common module parameters
  88. *
  89. * @see https://developers.whmcs.com/provisioning-modules/supported-functions/
  90. *
  91. * @return string 'success' or an error message
  92. */
  93. function siteBuilder_CreateAccount($params) {
  94. $username = strtolower(substr($params['clientsdetails']['firstname'],0,2) . substr($params['clientsdetails']['lastname'],0,3)) . $params['serviceid'];
  95. $userdomain = $params['domain'];
  96. try {
  97. Capsule::table('tblhosting')
  98. ->where('id', '=', $params['serviceid'])
  99. ->update(
  100. array(
  101. 'username' => $username,
  102. 'domain' => $userdomain,
  103. )
  104. );
  105. } catch (\Exception $e) {
  106. logModuleCall(
  107. 'siteBuilder',
  108. __FUNCTION__,
  109. $params,
  110. 'Error: could save username & domain in database',
  111. $e->getMessage()
  112. );
  113. return 'Error: could save username & password in database';
  114. }
  115. try {
  116. Capsule::table('sitePro_acc')
  117. ->insert(
  118. array(
  119. 'account' => $username,
  120. 'pid' => $params['serviceid'],
  121. 'enabled' => true,
  122. )
  123. );
  124. } catch (\Exception $e) {
  125. logModuleCall(
  126. 'siteBuilder',
  127. __FUNCTION__,
  128. $params,
  129. 'Error: could save username & serviceid in database',
  130. $e->getMessage()
  131. );
  132. return 'Error: could save username & serviceid in database';
  133. }
  134. return 'success';
  135. }
  136. /**
  137. * Removes a siteBuilder account.
  138. *
  139. * Called when a termination is requested. This can be invoked automatically for
  140. * overdue products if enabled, or requested manually by an admin user.
  141. *
  142. * @param array $params common module parameters
  143. *
  144. * @see https://developers.whmcs.com/provisioning-modules/supported-functions/
  145. *
  146. * @return string 'success' or an error message
  147. */
  148. function siteBuilder_TerminateAccount($params) {
  149. try {
  150. $active = Capsule::table('sitePro_acc')
  151. ->where('account',$params['username'])
  152. ->value('enabled');
  153. } catch (\Exception $e) {
  154. logModuleCall(
  155. 'siteBuilder',
  156. __FUNCTION__,
  157. $params,
  158. 'Error: could remove account from database',
  159. $e->getMessage()
  160. );
  161. return 'Error: could remove account from database';
  162. }
  163. if($active == true) {
  164. return 'Error: Account is active, please suspend account first';
  165. }
  166. try {
  167. Capsule::table('sitePro_site')
  168. ->where('relid',$params['serviceid'])
  169. ->delete();
  170. } catch (\Exception $e) {
  171. logModuleCall(
  172. 'siteBuilder',
  173. __FUNCTION__,
  174. $params,
  175. 'Error: could remove domains from database',
  176. $e->getMessage()
  177. );
  178. return 'Error: could remove domains from database';
  179. }
  180. try {
  181. Capsule::table('sitePro_acc')
  182. ->where('account',$params['username'])
  183. ->delete();
  184. } catch (\Exception $e) {
  185. logModuleCall(
  186. 'siteBuilder',
  187. __FUNCTION__,
  188. $params,
  189. 'Error: could remove account from database',
  190. $e->getMessage()
  191. );
  192. return 'Error: could remove account from database';
  193. }
  194. $siteBuilder = new ApiClient(getSiteBuilderApiURL($params), $params['serveraccesshash']);
  195. $response = $siteBuilder->terminate($params['domain'],$params['username']);
  196. if($response['status'] != '200') {
  197. return 'Error: ' . $response['response'];
  198. }
  199. return 'success';
  200. }
  201. /**
  202. * Set a siteBuilder account to status inactive.
  203. *
  204. * Called when a suspension is requested. This is invoked automatically by WHMCS
  205. * when a product becomes overdue on payment or can be called manually by admin
  206. * user.
  207. *
  208. * @param array $params common module parameters
  209. *
  210. * @see https://developers.whmcs.com/provisioning-modules/supported-functions/
  211. *
  212. * @return string 'success' or an error message
  213. */
  214. function siteBuilder_SuspendAccount($params) {
  215. $siteBuilder = new ApiClient(getSiteBuilderApiURL($params), $params['serveraccesshash']);
  216. $status = $siteBuilder->isprodenabled($params['domain'],$params['username']);
  217. if($status['status'] != '200') {
  218. return 'Error: ' . $status['error_msg'];
  219. }
  220. if($response['response']['isenabled'] == 'YES'){
  221. $response = $siteBuilder->disableprod($params['domain'],$params['username']);
  222. if($response['status'] != '200') {
  223. return 'Error: ' . $response['error_msg'];
  224. }
  225. }
  226. try {
  227. Capsule::table('sitePro_acc')
  228. ->where('account',$params['username'])
  229. ->update(array(
  230. 'enabled' => false,
  231. ));
  232. } catch (\Exception $e) {
  233. logModuleCall(
  234. 'siteBuilder',
  235. __FUNCTION__,
  236. $params,
  237. 'Error: could remove account from database',
  238. $e->getMessage()
  239. );
  240. return 'Error: could remove account from database';
  241. }
  242. return 'success';
  243. }
  244. /**
  245. * Set a siteBuilder account to status active.
  246. *
  247. * Called when an un-suspension is requested. This is invoked
  248. * automatically upon payment of an overdue invoice for a product, or
  249. * can be called manually by admin user.
  250. *
  251. * @param array $params common module parameters
  252. *
  253. * @see https://developers.whmcs.com/provisioning-modules/supported-functions/
  254. *
  255. * @return string 'success' or an error message
  256. */
  257. function siteBuilder_UnsuspendAccount($params) {
  258. try {
  259. Capsule::table('sitePro_acc')
  260. ->where('account',$params['username'])
  261. ->update(array(
  262. 'enabled' => true,
  263. ));
  264. } catch (\Exception $e) {
  265. logModuleCall(
  266. 'siteBuilder',
  267. __FUNCTION__,
  268. $params,
  269. 'Error: could remove account from database',
  270. $e->getMessage()
  271. );
  272. return 'Error: could remove account from database';
  273. }
  274. return 'success';
  275. }
  276. /**
  277. * Client area output logic handling.
  278. *
  279. * This function is used to define module specific client area output. It should
  280. * return an array consisting of a template file and optional additional
  281. * template variables to make available to that template.
  282. *
  283. * @param array $params common module parameters
  284. *
  285. * @see https://developers.whmcs.com/provisioning-modules/client-area-output/
  286. *
  287. * @return array
  288. */
  289. function siteBuilder_ClientArea($params) {
  290. $siteBuilder = new ApiClient(getSiteBuilderApiURL($params), $params['serveraccesshash']);
  291. $clientInfo = array('moduleclientarea' => '1');
  292. $clientInfo['domain'] = $params['domain'];
  293. $accountObj = Capsule::table('sitePro_acc')
  294. ->where('pid', $params['serviceid'])
  295. ->get();
  296. $sitesObj = Capsule::table('sitePro_site')
  297. ->where('relid', $params['serviceid'])
  298. ->get();
  299. $clientInfo['sites'] = [];
  300. $sslProd = 0;
  301. $sslDev = 0;
  302. foreach($sitesObj as $site){
  303. $response = $siteBuilder->getSSLDays($site->name, $params['username']);
  304. if($response['status'] == '200') {
  305. $sslProd = $response['ssl_remaining'];
  306. }
  307. $response = $siteBuilder->getSSLDays('dev.' . $site->name, $params['username']);
  308. if($response['status'] == '200') {
  309. $sslDev = $response['ssl_remaining'];
  310. }
  311. array_push($clientInfo['sites'],['name' => $site->name, 'sslProd' => $sslProd, 'sslDev' => $sslDev]);
  312. }
  313. return array(
  314. 'tabOverviewReplacementTemplate' => 'clientarea',
  315. 'vars' => $clientInfo,
  316. );
  317. }
  318. /**
  319. * Perform single sign-on for a siteBuilder account.
  320. *
  321. * When successful, returns a URL to which the user should be redirected.
  322. *
  323. * @param array $params common module parameters
  324. *
  325. * @see https://developers.whmcs.com/provisioning-modules/single-sign-on/
  326. *
  327. * @return array
  328. */
  329. function siteBuilder_ServiceSingleSignOn($params) {
  330. }
  331. /**
  332. * Upgrade or downgrade a siteBuilder account by package.
  333. *
  334. * Called to apply any change in product assignment or parameters. It
  335. * is called to provision upgrade or downgrade orders, as well as being
  336. * able to be invoked manually by an admin user.
  337. *
  338. * This same function is called for upgrades and downgrades of both
  339. * products and configurable options.
  340. *
  341. * @param array $params common module parameters
  342. *
  343. * @see https://developers.whmcs.com/provisioning-modules/supported-functions/
  344. *
  345. * @return string "success" or an error message
  346. */
  347. function siteBuilder_ChangePackage($params) {
  348. return 'success';
  349. }
  350. /**
  351. * Usage Update
  352. *
  353. * Important: Runs daily per server not per product
  354. * Run Manually: /admin/reports.php?report=disk_usage_summary&action=updatestats
  355. * @param array $params common module parameters
  356. *
  357. * @see https://developers.whmcs.com/provisioning-modules/usage-update/
  358. */
  359. function siteBuilder_UsageUpdate($params) {
  360. }
  361. /**
  362. * Additional actions a client user can invoke.
  363. *
  364. * Define additional actions a client user can perform for an instance of a
  365. * product/service.
  366. *
  367. * Any actions you define here will be automatically displayed in the available
  368. * list of actions within the client area.
  369. *
  370. * @return array
  371. */
  372. function siteBuilder_ClientAreaCustomButtonArray ($params) {
  373. return array(
  374. 'Neue Webseite' => 'newSite',
  375. );
  376. }
  377. /**
  378. * Additional actions a client user can invoke.
  379. *
  380. * Define additional actions a client user is allowed to perform for an instance of a
  381. * product/service.
  382. *
  383. * @see https://developers.whmcs.com/provisioning-modules/supported-functions/
  384. *
  385. * @return array
  386. */
  387. function siteBuilder_ClientAreaAllowedFunctions() {
  388. return array(
  389. "Add Site" => "addSite",
  390. "new Site" => "newSite",
  391. "Confirm Delete Site" => "delSiteConfirm",
  392. "Delete Site" => "delSite",
  393. );
  394. }
  395. /**
  396. * Opens a form to add a new domain.
  397. *
  398. * @param array $params common module parameters
  399. *
  400. * @see https://developers.whmcs.com/provisioning-modules/supported-functions/
  401. *
  402. * @return array template information
  403. */
  404. function siteBuilder_newSite($params) {
  405. return array(
  406. 'breadcrumb' => array(
  407. 'clientarea.php?action=productdetails&id=' . $params['serviceid'] . '&modop=custom&a=newSite' => 'Neue Webseite',
  408. ),
  409. 'templatefile' => 'siteBuilder_new_site',
  410. );
  411. }
  412. /**
  413. * Adds a new domain to a siteBuilder account.
  414. *
  415. * @param array $params common module parameters
  416. *
  417. * @see https://developers.whmcs.com/provisioning-modules/supported-functions/
  418. *
  419. * @return string "success" or an error message
  420. */
  421. function siteBuilder_addSite($params) {
  422. if(!filter_var($_POST['d'], FILTER_VALIDATE_DOMAIN, FILTER_FLAG_HOSTNAME)){
  423. return 'Error: invalid site name';
  424. }
  425. $site = $_POST['d'] . '.' . $params['domain'];
  426. $siteBuilder = new ApiClient(getSiteBuilderApiURL($params), $params['serveraccesshash']);
  427. $response = $siteBuilder->deployDev($params['username'], $site, $params['serverusername'], $params['serverpassword']);
  428. logModuleCall(
  429. 'siteBuilder',
  430. __FUNCTION__,
  431. $params,
  432. 'Error: could save site & serviceid in database',
  433. $response
  434. );
  435. if($response['status'] != '200') {
  436. return 'Error: ' . $response['response'];
  437. }
  438. try {
  439. Capsule::table('sitePro_site')
  440. ->insert(
  441. array(
  442. 'relid' => $params['serviceid'],
  443. 'name' => $site,
  444. 'enabled' => false,
  445. )
  446. );
  447. } catch (\Exception $e) {
  448. logModuleCall(
  449. 'siteBuilder',
  450. __FUNCTION__,
  451. $params,
  452. 'Error: could save site & serviceid in database',
  453. $e->getMessage()
  454. );
  455. return 'Error: could save site & serviceid in database';
  456. }
  457. return 'success';
  458. }
  459. /**
  460. * Opens a form to delete a domain from a siteBuilder account.
  461. *
  462. * @param array $params common module parameters
  463. *
  464. * @see https://developers.whmcs.com/provisioning-modules/supported-functions/
  465. *
  466. * @return array template information
  467. */
  468. function siteBuilder_delDomainConfirm($params) {
  469. return array(
  470. 'templatefile' => 'siteBuilder_del_domain_confirm',
  471. 'vars' => array(
  472. 'deldomain' => $_POST['d'],
  473. ),
  474. );
  475. }
  476. /**
  477. * Removes a domain from a siteBuilder account.
  478. *
  479. * @param array $params common module parameters
  480. *
  481. * @see https://developers.whmcs.com/provisioning-modules/supported-functions/
  482. *
  483. * @return string "success" or an error message
  484. */
  485. function siteBuilder_delDomain($params) {
  486. if(!filter_var($_POST['d'], FILTER_VALIDATE_DOMAIN, FILTER_FLAG_HOSTNAME)){
  487. return 'Error: invalid domain name';
  488. }
  489. return 'success';
  490. }
  491. /**
  492. * Returns API Url .
  493. *
  494. * @param string $params common module parameters
  495. * @param string $user
  496. * @param string $params common module parameters
  497. *
  498. * @return string $apiUrl
  499. */
  500. function getSiteBuilderApiURL($params) {
  501. $httpPrefix = $params['serversecure'] ? 'https://' : 'http://';
  502. $serverPort = $params['serverport'] ? ':' . $params['serverport'] . '/' : '/';
  503. return $httpPrefix . $params['serverhostname'] . $serverPort;
  504. }
  505. function siteBuilderCreateTables() {
  506. // Create a new table.
  507. if (!Capsule::schema()->hasTable('sitePro_acc')) {
  508. try {
  509. Capsule::schema()->create(
  510. 'sitePro_acc',
  511. function ($table) {
  512. /** @var \Illuminate\Database\Schema\Blueprint $table */
  513. $table->increments('id');
  514. $table->string('account');
  515. $table->integer('pid');
  516. $table->boolean('enabled');
  517. }
  518. );
  519. } catch (\Exception $e) {
  520. echo "Unable to create sitePro_acc: {$e->getMessage()}";
  521. }
  522. }
  523. if (!Capsule::schema()->hasTable('sitePro_site')) {
  524. try {
  525. Capsule::schema()->create(
  526. 'sitePro_site',
  527. function ($table) {
  528. /** @var \Illuminate\Database\Schema\Blueprint $table */
  529. $table->increments('id');
  530. $table->integer('relid');
  531. $table->string('name');
  532. $table->boolean('enabled');
  533. }
  534. );
  535. } catch (\Exception $e) {
  536. echo "Unable to create sitePro_site: {$e->getMessage()}";
  537. }
  538. }
  539. }