siteBuilder.php 35 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192
  1. <?php
  2. /**
  3. * WHMCS siteBuilder Provisioning Module
  4. *
  5. * Provisioning User Accounts & manage Websites 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. 'DefaultNonSSLPort' => '80',
  29. 'DefaultSSLPort' => '443',
  30. 'RequiresServer' => true
  31. );
  32. }
  33. /**
  34. * Create tables if neccessary
  35. * Define siteBuilder product configuration options.
  36. *
  37. * @see https://developers.whmcs.com/provisioning-modules/config-options/
  38. *
  39. * @return array
  40. */
  41. function siteBuilder_ConfigOptions() {
  42. // check for tables and create if neccessary
  43. siteBuilderCreateTables();
  44. // return ConfigOptions
  45. return ["BuilderURL" => [
  46. "FriendlyName" => "Builder URL", # Full Builder URL (prefix//hostname:port/)
  47. "Type" => "text", # Text Box
  48. "Size" => "25", # Defines the Field Width
  49. "Description" => "Full Builder URL (prefix//hostname:port/)",
  50. "Default" => "https://builder.thurdata.ch/",
  51. ], [
  52. "FriendlyName" => "Hosting Plan ID",
  53. "Type" => "text", # Text Box
  54. "Size" => "25", # Defines the Field Width
  55. "Description" => "Set the hostingPlan ID for this Product",
  56. "Default" => "Free",
  57. ], [
  58. "FriendlyName" => "Quota in MB",
  59. "Type" => "text", # Text Box
  60. "Size" => "25", # Defines the Field Width
  61. "Description" => "Set the Quoat matching Your HostingPlan (MB)",
  62. "Default" => "512",
  63. ]
  64. ];
  65. }
  66. /**
  67. * Test connection to a siteBuilder server with the given server parameters.
  68. *
  69. * Allows an admin user to verify that an API connection can be
  70. * successfully made with the given configuration parameters for a
  71. * server.
  72. *
  73. * When defined in a module, a test connection button will appear
  74. * alongside the server type dropdown when adding or editing an
  75. * existing server.
  76. *
  77. * @param array $params common module parameters
  78. *
  79. * @see https://developers.whmcs.com/provisioning-modules/module-parameters/
  80. *
  81. * @return array
  82. */
  83. function siteBuilder_Testconnection($params) {
  84. $siteBuilder = new ApiClient(getSiteBuilderApiURL($params), $params['serveraccesshash']);
  85. // ping remota API
  86. $response = $siteBuilder->ping($params['serverusername'], $params['serverpassword']);
  87. if($response['response']['answer'] == 'pong') {
  88. return array(
  89. 'success' => true,
  90. 'error' => '',
  91. );
  92. }
  93. return array(
  94. 'success' => false,
  95. 'error' => $response,
  96. );
  97. }
  98. /**
  99. * Provision a new siteBuilder account
  100. *
  101. * Attempt to provision a new siteBuilder account. This is
  102. * called any time provisioning is requested inside of WHMCS. Depending upon the
  103. * configuration, this can be any of:
  104. * * When a new order is placed
  105. * * When an invoice for a new order is paid
  106. * * Upon manual request by an admin user
  107. *
  108. * @param array $params common module parameters
  109. *
  110. * @see https://developers.whmcs.com/provisioning-modules/supported-functions/
  111. *
  112. * @return string 'success' or an error message
  113. */
  114. function siteBuilder_CreateAccount($params) {
  115. $username = strtolower(substr($params['clientsdetails']['firstname'],0,2) . substr($params['clientsdetails']['lastname'],0,3)) . $params['serviceid'];
  116. $userdomain = $params['domain'];
  117. // set DNS
  118. /* disabled on dev, has to be already set in test env
  119. $response = siteBuildersetDNS($params, $userdomain);
  120. if($response != 'success') {
  121. return $response;
  122. }
  123. */
  124. // update service
  125. try {
  126. Capsule::table('tblhosting')
  127. ->where('id', '=', $params['serviceid'])
  128. ->update(
  129. array(
  130. 'username' => $username,
  131. 'domain' => $userdomain,
  132. )
  133. );
  134. } catch (\Exception $e) {
  135. logModuleCall(
  136. 'siteBuilder',
  137. __FUNCTION__,
  138. $params,
  139. 'Error: could save username & domain in database',
  140. $e->getMessage()
  141. );
  142. return 'Error: could save username & password in database';
  143. }
  144. // add account to database
  145. try {
  146. Capsule::table('sitePro_acc')
  147. ->insert(
  148. array(
  149. 'account' => $username,
  150. 'pid' => $params['serviceid'],
  151. 'enabled' => true,
  152. )
  153. );
  154. } catch (\Exception $e) {
  155. logModuleCall(
  156. 'siteBuilder',
  157. __FUNCTION__,
  158. $params,
  159. 'Error: could save username & serviceid in database',
  160. $e->getMessage()
  161. );
  162. return 'Error: could save username & serviceid in database';
  163. }
  164. $siteBuilder = new ApiClient(getSiteBuilderApiURL($params), $params['serveraccesshash']);
  165. // create siteBuilder account
  166. $response = $siteBuilder->create($params['username'], $params['domain'], $params['serverusername'], $params['serverpassword']);
  167. if($response['status'] != '200') {
  168. return 'Error: ' . $response['response']['error'];
  169. }
  170. // create siteBuilder base config for new account
  171. $response = $siteBuilder->init($params['username'], $params['domain'], $params['serverusername'], $params['serverpassword']);
  172. if($response['status'] != '200') {
  173. return 'Error: ' . $response['response']['error'];
  174. }
  175. // set quota for new account
  176. $response = $siteBuilder->setQuota($params['username'], $params['configoption3'], $params['serverusername'], $params['serverpassword']);
  177. if($response['status'] != '200') {
  178. return 'Error: ' . $response['response']['error'];
  179. }
  180. return 'success';
  181. }
  182. /**
  183. * Removes a siteBuilder account and undeploy all related sites
  184. *
  185. * Called when a termination is requested. This can be invoked automatically for
  186. * overdue products if enabled, or requested manually by an admin user.
  187. *
  188. * @param array $params common module parameters
  189. *
  190. * @see https://developers.whmcs.com/provisioning-modules/supported-functions/
  191. *
  192. * @return string 'success' or an error message
  193. */
  194. function siteBuilder_TerminateAccount($params) {
  195. // check if account is suspended
  196. try {
  197. $active = Capsule::table('sitePro_acc')
  198. ->where('account',$params['username'])
  199. ->value('enabled');
  200. } catch (\Exception $e) {
  201. logModuleCall(
  202. 'siteBuilder',
  203. __FUNCTION__,
  204. $params,
  205. 'Error: could fetch account from database',
  206. $e->getMessage()
  207. );
  208. return 'Error: could fetch account from database';
  209. }
  210. if($active == true) {
  211. return 'Error: Account is active, please suspend account first';
  212. }
  213. // undeploy all related sites
  214. $sites = getSites($params['serviceid']);
  215. $siteBuilder = new ApiClient(getSiteBuilderApiURL($params), $params['serveraccesshash']);
  216. if(!empty($sites)) {
  217. foreach($sites as $site) {
  218. $response = $siteBuilder->undeploy($params['username'], $site, $params['serverusername'], $params['serverpassword']);
  219. if($response['status'] != '200') {
  220. return 'Error: ' . $response['response'];
  221. }
  222. }
  223. }
  224. // cleanup database
  225. try {
  226. Capsule::table('sitePro_site')
  227. ->where('relid',$params['serviceid'])
  228. ->delete();
  229. } catch (\Exception $e) {
  230. logModuleCall(
  231. 'siteBuilder',
  232. __FUNCTION__,
  233. $params,
  234. 'Error: could remove site from database',
  235. $e->getMessage()
  236. );
  237. return 'Error: could remove site from database';
  238. }
  239. // terminate account
  240. $response = $siteBuilder->terminate($params['username'], $params['domain']);
  241. if($response['status'] != '200') {
  242. return 'Error: ' . $response['response']['error'];
  243. }
  244. try {
  245. Capsule::table('sitePro_acc')
  246. ->where('account',$params['username'])
  247. ->delete();
  248. } catch (\Exception $e) {
  249. logModuleCall(
  250. 'siteBuilder',
  251. __FUNCTION__,
  252. $params,
  253. 'Error: could remove account from database',
  254. $e->getMessage()
  255. );
  256. return 'Error: could remove account from database';
  257. }
  258. return 'success';
  259. }
  260. /**
  261. * Set a siteBuilder account to status inactive.
  262. *
  263. * Called when a suspension is requested. This is invoked automatically by WHMCS
  264. * when a product becomes overdue on payment or can be called manually by admin
  265. * user.
  266. *
  267. * @param array $params common module parameters
  268. *
  269. * @see https://developers.whmcs.com/provisioning-modules/supported-functions/
  270. *
  271. * @return string 'success' or an error message
  272. */
  273. function siteBuilder_SuspendAccount($params) {
  274. // disable default site
  275. $siteBuilder = new ApiClient(getSiteBuilderApiURL($params), $params['serveraccesshash']);
  276. $status = $siteBuilder->isenabled($params['username'],$params['domain']);
  277. if($status['status'] != '200') {
  278. return 'Error: ' . $status['response']['error'];
  279. }
  280. if($status['response']['isenabled'] == 'YES'){
  281. $response = $siteBuilder->disable($params['username'],$params['domain']);
  282. if($response['status'] != '200') {
  283. return 'Error: ' . $response['response']['error'];
  284. }
  285. }
  286. // set account to disabled in database
  287. try {
  288. Capsule::table('sitePro_acc')
  289. ->where('account',$params['username'])
  290. ->update(array(
  291. 'enabled' => false,
  292. ));
  293. } catch (\Exception $e) {
  294. logModuleCall(
  295. 'siteBuilder',
  296. __FUNCTION__,
  297. $params,
  298. 'Error: could not disable account in database',
  299. $e->getMessage()
  300. );
  301. return 'Error: could not disable account in database';
  302. }
  303. // disable all sites but not change status in DB for unsuspend restoring
  304. $sites = getSites($params['serviceid']);
  305. if(!empty($sites)) {
  306. foreach($sites as $site) {
  307. $response = $siteBuilder->disable($params['username'], $site, $params['serverusername'], $params['serverpassword']);
  308. logModuleCall(
  309. 'siteBuilder',
  310. __FUNCTION__,
  311. $params,
  312. 'Debug',
  313. $response
  314. );
  315. if($response['status'] != '200') {
  316. return 'Error: ' . $response['response']['error'];
  317. }
  318. }
  319. }
  320. return 'success';
  321. }
  322. /**
  323. * Set a siteBuilder account to status active and enable active sites
  324. *
  325. * Called when an un-suspension is requested. This is invoked
  326. * automatically upon payment of an overdue invoice for a product, or
  327. * can be called manually by admin user.
  328. *
  329. * @param array $params common module parameters
  330. *
  331. * @see https://developers.whmcs.com/provisioning-modules/supported-functions/
  332. *
  333. * @return string 'success' or an error message
  334. */
  335. function siteBuilder_UnsuspendAccount($params) {
  336. $siteBuilder = new ApiClient(getSiteBuilderApiURL($params), $params['serveraccesshash']);
  337. // enable deafult site
  338. $response = $siteBuilder->enable($params['username'], $params['domain'], $params['serverusername'], $params['serverpassword']);
  339. if($response['status'] != '200') {
  340. return 'Error: ' . $response['response']['error'];
  341. }
  342. // set account to enabled in database
  343. try {
  344. Capsule::table('sitePro_acc')
  345. ->where('account',$params['username'])
  346. ->update(array(
  347. 'enabled' => true,
  348. ));
  349. } catch (\Exception $e) {
  350. logModuleCall(
  351. 'siteBuilder',
  352. __FUNCTION__,
  353. $params,
  354. 'Error: could update account in database',
  355. $e->getMessage()
  356. );
  357. return 'Error: could update account in database';
  358. }
  359. // enable active sites
  360. $sites = getSitesEnabled($params['serviceid']);
  361. logModuleCall(
  362. 'siteBuilder',
  363. __FUNCTION__,
  364. $params,
  365. 'Debug',
  366. $site
  367. );
  368. if(!empty($sites)) {
  369. foreach($sites as $site) {
  370. $response = $siteBuilder->enable($params['username'], $site, $params['serverusername'], $params['serverpassword']);
  371. if($response['status'] != '200') {
  372. return 'Error: ' . $response['response']['error'];
  373. }
  374. }
  375. }
  376. return 'success';
  377. }
  378. /**
  379. * Client area output logic handling.
  380. *
  381. * This function is used to define module specific client area output. It should
  382. * return an array consisting of a template file and optional additional
  383. * template variables to make available to that template.
  384. *
  385. * @param array $params common module parameters
  386. *
  387. * @see https://developers.whmcs.com/provisioning-modules/client-area-output/
  388. *
  389. * @return array
  390. */
  391. function siteBuilder_ClientArea($params) {
  392. $siteBuilder = new ApiClient(getSiteBuilderApiURL($params), $params['serveraccesshash']);
  393. $clientInfo = array('moduleclientarea' => '1');
  394. $clientInfo['domain'] = $params['domain'];
  395. // Client status
  396. $accEnabled = Capsule::table('sitePro_acc')
  397. ->where('pid', $params['serviceid'])
  398. ->value('enabled');
  399. $clientInfo['account'] = ['enabled' => $accEnabled];
  400. $clientInfo['sites'] = [];
  401. // Client sites
  402. $sites = getSites($params['serviceid']);
  403. foreach($sites as $site){
  404. $response = $siteBuilder->getSSLDays($params['username'], $site);
  405. if($response['status'] == '200') {
  406. $sslSite = $response['response']['ssl_remaining'];
  407. }
  408. $response = $siteBuilder->isenabled($params['username'], $site);
  409. if($response['status'] == '200') {
  410. $enabled = $response['response']['isenabled'];
  411. }
  412. array_push($clientInfo['sites'],['name' => $site, 'sslSite' => $sslSite, 'enabled' => $enabled]);
  413. }
  414. // Client Quota
  415. $response = $siteBuilder->getQuota($params['username']);
  416. if($response['status'] != '200') {
  417. logModuleCall(
  418. 'siteBuilder',
  419. __FUNCTION__,
  420. $params,
  421. 'Error getting Quota',
  422. $response
  423. );
  424. }
  425. $clientInfo['quota'] = round($response['response']['quota'][0]['blocks']/1024);
  426. $clientInfo['limit'] = round($response['response']['quota'][0]['hard']/1024);
  427. // return template vars
  428. return array(
  429. 'tabOverviewReplacementTemplate' => 'clientarea',
  430. 'vars' => $clientInfo,
  431. );
  432. }
  433. /**
  434. * Upgrade or downgrade a siteBuilder account by package.
  435. *
  436. * Called to apply any change in product assignment or parameters. It
  437. * is called to provision upgrade or downgrade orders, as well as being
  438. * able to be invoked manually by an admin user.
  439. *
  440. * This same function is called for upgrades and downgrades of both
  441. * products and configurable options.
  442. *
  443. * @param array $params common module parameters
  444. *
  445. * @see https://developers.whmcs.com/provisioning-modules/supported-functions/
  446. *
  447. * @return string "success" or an error message
  448. */
  449. function siteBuilder_ChangePackage($params) {
  450. $siteBuilder = new ApiClient(getSiteBuilderApiURL($params), $params['serveraccesshash']);
  451. // configoption3 contains quota in MB
  452. $response = $siteBuilder->setQuota($params['username'], $params['configoption3'], $params['serverusername'], $params['serverpassword']);
  453. if($response['status'] != '200') {
  454. return 'Error: ' . $response['response']['error'];
  455. }
  456. return 'success';
  457. }
  458. /**
  459. * Usage Update
  460. *
  461. * Important: Runs daily per server not per product
  462. * Run Manually: /admin/reports.php?report=disk_usage_summary&action=updatestats
  463. * @param array $params common module parameters
  464. *
  465. * @see https://developers.whmcs.com/provisioning-modules/usage-update/
  466. */
  467. function siteBuilder_UsageUpdate($params) {
  468. $siteBuilder = new ApiClient(getSiteBuilderApiURL($params), $params['serveraccesshash']);
  469. $response = $siteBuilder->getStats();
  470. if($response['status'] != '200') {
  471. logActivity('ERROR: Unable to update sitebuilder server usage: ' . implode('#',[$response]));
  472. }
  473. $stats = $response['response']['quota'];
  474. foreach($stats as $stat){
  475. try {
  476. Capsule::table('tblhosting')
  477. ->where('server', $params['serverid'])
  478. ->where('username', $stat['user'])
  479. ->update([
  480. 'diskusage' => $stat['used']/1024,
  481. 'disklimit' => $stat['hard']/1024,
  482. 'lastupdate' => Capsule::raw('now()'),
  483. ]);
  484. } catch (\Exception $e) {
  485. logActivity('ERROR: Unable to update sitebuilder server usage: ' . $e->getMessage());
  486. }
  487. logModuleCall(
  488. 'siteBuilder',
  489. __FUNCTION__,
  490. $stat,
  491. 'debug',
  492. $params
  493. );
  494. }
  495. }
  496. /**
  497. * Additional actions a client user can invoke.
  498. *
  499. * Define additional actions a client user can perform for an instance of a
  500. * product/service.
  501. *
  502. * Any actions you define here will be automatically displayed in the available
  503. * list of actions within the client area.
  504. *
  505. * @return array
  506. */
  507. function siteBuilder_ClientAreaCustomButtonArray ($params) {
  508. return array(
  509. 'Neue Webseite' => 'newSite',
  510. );
  511. }
  512. /**
  513. * Additional actions a client user can invoke.
  514. *
  515. * Define additional actions a client user is allowed to perform for an instance of a
  516. * product/service.
  517. *
  518. * @see https://developers.whmcs.com/provisioning-modules/supported-functions/
  519. *
  520. * @return array
  521. */
  522. function siteBuilder_ClientAreaAllowedFunctions() {
  523. return array(
  524. 'Add Site' => 'addSite',
  525. 'New Site' => 'newSite',
  526. 'Confirm Delete Site' => 'delSiteConfirm',
  527. 'Delete Site' => 'delSite',
  528. 'Edit Site' => 'editSite',
  529. 'Conform Revert Site' => 'revSiteConfirm',
  530. 'Revert Site' => 'revSite',
  531. 'Disable Site' => 'disableSite',
  532. 'Enable Site' => 'enableSite'
  533. );
  534. }
  535. /**
  536. * Opens a form to add a new domain.
  537. *
  538. * @param array $params common module parameters
  539. *
  540. * @see https://developers.whmcs.com/provisioning-modules/supported-functions/
  541. *
  542. * @return array template information
  543. */
  544. function siteBuilder_newSite($params) {
  545. return array(
  546. 'breadcrumb' => array(
  547. 'clientarea.php?action=productdetails&id=' . $params['serviceid'] . '&modop=custom&a=newSite' => 'Neue Webseite',
  548. ),
  549. 'templatefile' => 'siteBuilder_new_site',
  550. );
  551. }
  552. /**
  553. * Adds a new domain to a siteBuilder account.
  554. *
  555. * @param array $params common module parameters
  556. *
  557. * @see https://developers.whmcs.com/provisioning-modules/supported-functions/
  558. *
  559. * @return string "success" or an error message
  560. */
  561. function siteBuilder_addSite($params) {
  562. if(empty($_POST['d'])) {
  563. $site = $params['domain'];
  564. } else {
  565. if(!filter_var($_POST['d'], FILTER_VALIDATE_DOMAIN, FILTER_FLAG_HOSTNAME)){
  566. return 'Error: invalid site name';
  567. }
  568. $site = $_POST['d'] . '.' . $params['domain'];
  569. }
  570. // set DNS
  571. /* disabled on dev, has to be already set in test env
  572. $response = siteBuildersetDNS($params, $site);
  573. if($response != 'success') {
  574. return $response;
  575. }
  576. */
  577. $siteBuilder = new ApiClient(getSiteBuilderApiURL($params), $params['serveraccesshash']);
  578. // set up webconfig
  579. $response = $siteBuilder->init($params['username'], $site, $params['serverusername'], $params['serverpassword']);
  580. if($response['status'] != '200') {
  581. return 'Error: ' . $response['response']['error'];
  582. }
  583. // update DB
  584. try {
  585. Capsule::table('sitePro_site')
  586. ->insert(
  587. array(
  588. 'relid' => $params['serviceid'],
  589. 'name' => $site,
  590. 'enabled' => true,
  591. )
  592. );
  593. } catch (\Exception $e) {
  594. logModuleCall(
  595. 'siteBuilder',
  596. __FUNCTION__,
  597. $params,
  598. 'Error: could save site & serviceid in database',
  599. $e->getMessage()
  600. );
  601. return 'Error: could save site & serviceid in database';
  602. }
  603. return 'success';
  604. }
  605. /**
  606. * Creates a sitePro editor session and redirect on success
  607. *
  608. * @param array $params common module parameters
  609. *
  610. * @see https://developers.whmcs.com/provisioning-modules/supported-functions/
  611. *
  612. * @return string "success" or an error message
  613. */
  614. function siteBuilder_editSite($params) {
  615. if(!filter_var($_POST['s'], FILTER_VALIDATE_DOMAIN, FILTER_FLAG_HOSTNAME)){
  616. return 'Error: invalid site name';
  617. }
  618. $site = $_POST['s'];
  619. $api = new SiteProApiClient('https://builder.thurdata.ch/api/', 'apikey0', '993yVHwC05TLsx2JI2XFlAhkkPUxR6JbQUYbI.a5HiRtmNV9');
  620. // use this for enterprise licenses and change 'your-bulder-domain.com' to your builder domain
  621. //$api = new SiteProApiClient('http://your-bulder-domain.com/api/', 'your_api_username', 'your_api_password');
  622. try {
  623. // this call is used to open builder, so you need to set correct parameters to represent users website you want to open
  624. // this data usually comes from your user/hosting manager system
  625. $res = $api->remoteCall('requestLogin', array(
  626. 'type' => 'internal', // (required) 'internal'
  627. 'domain' => $site, // (required) domain of the user website you want to edit
  628. 'lang' => 'de', // (optional) 2-letter language code, set language code you whant builder to open in
  629. 'apiUrl' => getSiteBuilderApiURL($params) . 'deploy/' . $params['username'] . '/' . $site, // (required) API endpoint URL
  630. 'resellerClientAccountId' => $params['serviceid'], // (required) ID of website/user in your system
  631. 'username' => $params['serverusername'], // (optional) authorization username to be used with API endpoint
  632. 'password' => 'your-secure-password', // (optional) authorization password to be used with API endpoint
  633. 'hostingPlan' => $params['configoption2'],
  634. ));
  635. if (!$res || !is_object($res)) {
  636. logModuleCall(
  637. 'siteBuilder',
  638. __FUNCTION__,
  639. $params,
  640. 'Error: Response format error',
  641. $res
  642. );
  643. return 'Error: Response format error';
  644. } else if (isset($res->url) && $res->url) {
  645. logModuleCall(
  646. 'siteBuilder',
  647. __FUNCTION__,
  648. $params,
  649. 'Debug',
  650. $res
  651. );
  652. // on success redirect to builder URL
  653. header('Location: '.$res->url, true);
  654. exit();
  655. } else {
  656. logModuleCall(
  657. 'siteBuilder',
  658. __FUNCTION__,
  659. $params,
  660. 'Error: Unknown error',
  661. $res
  662. );
  663. return 'Error: Unknown error';
  664. }
  665. } catch (\Exception $e) {
  666. logModuleCall(
  667. 'siteBuilder',
  668. __FUNCTION__,
  669. $params,
  670. 'Error: Request error',
  671. $e->getMessage()
  672. );
  673. return 'Error: Request error';
  674. }
  675. return 'success';
  676. }
  677. /**
  678. * Opens a form to delete a domain from a siteBuilder account.
  679. *
  680. * @param array $params common module parameters
  681. *
  682. * @see https://developers.whmcs.com/provisioning-modules/supported-functions/
  683. *
  684. * @return array template information
  685. */
  686. function siteBuilder_delSiteConfirm() {
  687. return array(
  688. 'templatefile' => 'siteBuilder_del_site_confirm',
  689. 'vars' => array(
  690. 'delsite' => $_POST['s'],
  691. ),
  692. );
  693. }
  694. /**
  695. * Removes a site from a siteBuilder account.
  696. *
  697. * @param array $params common module parameters
  698. *
  699. * @see https://developers.whmcs.com/provisioning-modules/supported-functions/
  700. *
  701. * @return string "success" or an error message
  702. */
  703. function siteBuilder_delSite($params) {
  704. if(!filter_var($_POST['s'], FILTER_VALIDATE_DOMAIN, FILTER_FLAG_HOSTNAME)){
  705. return 'Error: invalid domain name';
  706. }
  707. $site = $_POST['s'];
  708. $siteBuilder = new ApiClient(getSiteBuilderApiURL($params), $params['serveraccesshash']);
  709. // undeploy
  710. $response = $siteBuilder->undeploy($params['username'], $site, $params['serverusername'], $params['serverpassword']);
  711. if($response['status'] != '200') {
  712. return 'Error: ' . $response['response']['error'];
  713. }
  714. // remove builder session
  715. $api = new SiteProApiClient('https://builder.thurdata.ch/api/', 'apikey0', '993yVHwC05TLsx2JI2XFlAhkkPUxR6JbQUYbI.a5HiRtmNV9');
  716. try {
  717. // this call is used to open builder, so you need to set correct parameters to represent users website you want to open
  718. // this data usually comes from your user/hosting manager system
  719. $res = $api->remoteCall('requestLogin', array(
  720. 'type' => 'internal', // (required) 'internal'
  721. 'domain' => $site, // (required) domain of the user website you want to edit
  722. 'lang' => 'de', // (optional) 2-letter language code, set language code you whant builder to open in
  723. 'apiUrl' => getSiteBuilderApiURL($params) . 'deploy/' . $params['username'] . '/' . $site, // (required) API endpoint URL
  724. 'resellerClientAccountId' => $params['serviceid'], // (required) ID of website/user in your system
  725. 'username' => $params['serverusername'], // (optional) authorization username to be used with API endpoint
  726. 'password' => 'your-secure-password', // (optional) authorization password to be used with API endpoint
  727. ));
  728. if (!$res || !is_object($res)) {
  729. logModuleCall(
  730. 'siteBuilder',
  731. __FUNCTION__,
  732. $params,
  733. 'Error: Response format error',
  734. $res
  735. );
  736. return 'Error: Response format error';
  737. } else if (isset($res->url) && $res->url) {
  738. $result = $api->remoteCall('delete-site', array(
  739. 'domain' => $site
  740. ));
  741. if (!$result || !is_object($result)) {
  742. logModuleCall(
  743. 'siteBuilder',
  744. __FUNCTION__,
  745. $params,
  746. 'Error: Response format error',
  747. $result
  748. );
  749. return 'Error: Response format error';
  750. } else if (isset($result->ok) && $res->ok) {
  751. return 'success';
  752. }
  753. } else {
  754. logModuleCall(
  755. 'siteBuilder',
  756. __FUNCTION__,
  757. $params,
  758. 'Error: Unknown error',
  759. $res
  760. );
  761. return 'Error: Unknown error';
  762. }
  763. } catch (\Exception $e) {
  764. logModuleCall(
  765. 'siteBuilder',
  766. __FUNCTION__,
  767. $params,
  768. 'Error: Request error',
  769. $e->getMessage()
  770. );
  771. return 'Error: Request error';
  772. }
  773. // update DB
  774. try {
  775. Capsule::table('sitePro_site')
  776. ->where('name', $site)
  777. ->delete();
  778. } catch (\Exception $e) {
  779. logModuleCall(
  780. 'siteBuilder',
  781. __FUNCTION__,
  782. $params,
  783. 'Error: could not remove site from database',
  784. $e->getMessage()
  785. );
  786. return 'Error: could not remove site from database';
  787. }
  788. // unset DNS
  789. /* disabled on dev, has to be already set in test env
  790. $response = siteBuilderunsetDNS($params, $site);
  791. if($response != 'success') {
  792. return $response;
  793. }
  794. */
  795. return 'success';
  796. }
  797. /**
  798. * Opens a form to re-init a website.
  799. *
  800. * @param array $params common module parameters
  801. *
  802. * @see https://developers.whmcs.com/provisioning-modules/supported-functions/
  803. *
  804. * @return array template information
  805. */
  806. function siteBuilder_revSiteConfirm($params) {
  807. return array(
  808. 'templatefile' => 'siteBuilder_rev_site_confirm',
  809. 'vars' => array(
  810. 'revSite' => $_POST['s'],
  811. ),
  812. );
  813. }
  814. /**
  815. * Revert all Changes (re-init) of the Site.
  816. *
  817. * @param array $params common module parameters
  818. *
  819. * @see https://developers.whmcs.com/provisioning-modules/supported-functions/
  820. *
  821. * @return string "success" or an error message
  822. */
  823. function siteBuilder_revSite($params) {
  824. if(!filter_var($_POST['s'], FILTER_VALIDATE_DOMAIN, FILTER_FLAG_HOSTNAME)){
  825. return 'Error: invalid site name';
  826. }
  827. $site = $_POST['s'];
  828. $siteBuilder = new ApiClient(getSiteBuilderApiURL($params), $params['serveraccesshash']);
  829. // re-init site on webhost
  830. $response = $siteBuilder->revert($params['username'], $site, $params['serverusername'], $params['serverpassword']);
  831. if($response['status'] != '200') {
  832. return 'Error: ' . $response['response']['error'];
  833. }
  834. // remove builder session
  835. $api = new SiteProApiClient('https://builder.thurdata.ch/api/', 'apikey0', '993yVHwC05TLsx2JI2XFlAhkkPUxR6JbQUYbI.a5HiRtmNV9');
  836. try {
  837. // this call is used to open builder, so you need to set correct parameters to represent users website you want to open
  838. // this data usually comes from your user/hosting manager system
  839. $res = $api->remoteCall('requestLogin', array(
  840. 'type' => 'internal', // (required) 'internal'
  841. 'domain' => $site, // (required) domain of the user website you want to edit
  842. 'lang' => 'de', // (optional) 2-letter language code, set language code you whant builder to open in
  843. 'apiUrl' => getSiteBuilderApiURL($params) . 'deploy/' . $params['username'] . '/' . $site, // (required) API endpoint URL
  844. 'resellerClientAccountId' => $params['serviceid'], // (required) ID of website/user in your system
  845. 'username' => $params['serverusername'], // (optional) authorization username to be used with API endpoint
  846. 'password' => 'your-secure-password', // (optional) authorization password to be used with API endpoint
  847. ));
  848. if (!$res || !is_object($res)) {
  849. logModuleCall(
  850. 'siteBuilder',
  851. __FUNCTION__,
  852. $params,
  853. 'Error: Response format error',
  854. $res
  855. );
  856. return 'Error: Response format error';
  857. } else if (isset($res->url) && $res->url) {
  858. $result = $api->remoteCall('delete-site', array(
  859. 'domain' => $site
  860. ));
  861. if (!$result || !is_object($result)) {
  862. logModuleCall(
  863. 'siteBuilder',
  864. __FUNCTION__,
  865. $params,
  866. 'Error: Response format error',
  867. $result
  868. );
  869. return 'Error: Response format error';
  870. } else if (isset($result->ok) && $res->ok) {
  871. return 'success';
  872. }
  873. } else {
  874. logModuleCall(
  875. 'siteBuilder',
  876. __FUNCTION__,
  877. $params,
  878. 'Error: Unknown error',
  879. $res
  880. );
  881. return 'Error: Unknown error';
  882. }
  883. } catch (\Exception $e) {
  884. logModuleCall(
  885. 'siteBuilder',
  886. __FUNCTION__,
  887. $params,
  888. 'Error: Request error',
  889. $e->getMessage()
  890. );
  891. return 'Error: Request error';
  892. }
  893. return 'success';
  894. }
  895. /**
  896. * Enables a website.
  897. *
  898. * @param array $params common module parameters
  899. *
  900. * @see https://developers.whmcs.com/provisioning-modules/supported-functions/
  901. *
  902. * @return string "success" or an error message
  903. */
  904. function siteBuilder_enableSite($params) {
  905. if(!filter_var($_POST['s'], FILTER_VALIDATE_DOMAIN, FILTER_FLAG_HOSTNAME)){
  906. return 'Error: invalid site name';
  907. }
  908. $site = $_POST['s'];
  909. $siteBuilder = new ApiClient(getSiteBuilderApiURL($params), $params['serveraccesshash']);
  910. // enable
  911. $response = $siteBuilder->enable($params['username'], $site, $params['serverusername'], $params['serverpassword']);
  912. if($response['status'] != '200') {
  913. return 'Error: ' . $response['response']['error'];
  914. }
  915. // update DB
  916. try {
  917. Capsule::table('sitePro_site')
  918. ->where('relid',$params['serviceid'])
  919. ->where('name',$site)
  920. ->update(array(
  921. 'enabled' => true,
  922. ));
  923. } catch (\Exception $e) {
  924. logModuleCall(
  925. 'siteBuilder',
  926. __FUNCTION__,
  927. $params,
  928. 'Error: could save site status in database',
  929. $e->getMessage()
  930. );
  931. return 'Error: could save site status in database';
  932. }
  933. return 'success';
  934. }
  935. /**
  936. * Disables a website.
  937. *
  938. * @param array $params common module parameters
  939. *
  940. * @see https://developers.whmcs.com/provisioning-modules/supported-functions/
  941. *
  942. * @return string "success" or an error message
  943. */
  944. function siteBuilder_disableSite($params) {
  945. if(!filter_var($_POST['s'], FILTER_VALIDATE_DOMAIN, FILTER_FLAG_HOSTNAME)){
  946. return 'Error: invalid site name';
  947. }
  948. $site = $_POST['s'];
  949. $siteBuilder = new ApiClient(getSiteBuilderApiURL($params), $params['serveraccesshash']);
  950. // disable
  951. $response = $siteBuilder->disable($params['username'], $site, $params['serverusername'], $params['serverpassword']);
  952. if($response['status'] != '200') {
  953. return 'Error: ' . $response['response']['error'];
  954. }
  955. // update DB
  956. try {
  957. Capsule::table('sitePro_site')
  958. ->where('relid',$params['serviceid'])
  959. ->where('name',$site)
  960. ->update(array(
  961. 'enabled' => false,
  962. ));
  963. } catch (\Exception $e) {
  964. logModuleCall(
  965. 'siteBuilder',
  966. __FUNCTION__,
  967. $params,
  968. 'Error: could save site status in database',
  969. $e->getMessage()
  970. );
  971. return 'Error: could save site status in database';
  972. }
  973. return 'success';
  974. }
  975. // Helpers
  976. /**
  977. * Update a DNS zone for a domain setting a new record for a domain or subdomain of a CWP7 account.
  978. *
  979. * @param array $params common module parameters
  980. *
  981. * @see https://developers.whmcs.com/provisioning-modules/supported-functions/
  982. *
  983. * @return string "success" or an error message
  984. */
  985. function siteBuildersetDNS($params, $site) {
  986. $siteName = $site . '.';
  987. $zoneRecords = array();
  988. $domainRecord = array(
  989. 'line' => $siteName.'|A|0',
  990. 'name' => $siteName,
  991. 'type' => 'A',
  992. 'class' => 'IN',
  993. 'data' => array(
  994. 'address' => $params['serverip'],
  995. ),
  996. );
  997. array_push($zoneRecords, $domainRecord);
  998. $zoneIDcollection = Capsule::table('dns_manager2_zone')
  999. ->select('id')
  1000. ->where('name', '=', $params['domain'])
  1001. ->where('clientid', '=', $params['userid'])
  1002. ->get();
  1003. $zoneIDobj = $zoneIDcollection[0];
  1004. $zoneID = $zoneIDobj->{'id'};
  1005. if(!isset($zoneID)) {
  1006. return 'Error: Zone for domain ' . $params['domain'] . ' or not owned by client';
  1007. }
  1008. $dnsZone = localAPI('dnsmanager', array( 'dnsaction' => 'getZone', 'zone_id' => $zoneID));
  1009. foreach($dnsZone['data']->records as $record) {
  1010. if(($record->name != $siteName) || ($record->type != 'A' && $record->type != 'CNAME')) {
  1011. array_push($zoneRecords, $record);
  1012. };
  1013. }
  1014. $result = localAPI('dnsmanager' ,
  1015. array(
  1016. 'dnsaction' => 'updateZone',
  1017. 'zone_id' => $zoneID,
  1018. 'records' => $zoneRecords,
  1019. )
  1020. );
  1021. if($result['result'] != 'success') {
  1022. return 'Error: ' . $result['message'];
  1023. }
  1024. return 'success';
  1025. }
  1026. /**
  1027. * Removing a DNS record for a site of a siteBuilder account.
  1028. *
  1029. * @param array $params common module parameters
  1030. *
  1031. * @see https://developers.whmcs.com/provisioning-modules/supported-functions/
  1032. *
  1033. * @return string "success" or an error message
  1034. */
  1035. function siteBuilderunsetDNS($params, $site) {
  1036. $siteName = $site . '.';
  1037. $zoneRecords = array();
  1038. $zoneIDcollection = Capsule::table('dns_manager2_zone')
  1039. ->select('id')
  1040. ->where('name', '=', $params['domain'])
  1041. ->where('clientid', '=', $params['userid'])
  1042. ->get();
  1043. $zoneIDobj = $zoneIDcollection[0];
  1044. $zoneID = $zoneIDobj->{'id'};
  1045. if(!isset($zoneID)) {
  1046. return 'Error: Zone for domain ' . $params['domain'] . ' or not owned by client';
  1047. }
  1048. $dnsZone = localAPI('dnsmanager', array( 'dnsaction' => 'getZone', 'zone_id' => $zoneID));
  1049. foreach($dnsZone['data']->records as $record) {
  1050. if(($record->name != $siteName) || ($record->type != 'A' && $record->type != 'CNAME')) {
  1051. array_push($zoneRecords, $record);
  1052. };
  1053. }
  1054. $result = localAPI('dnsmanager' ,
  1055. array(
  1056. 'dnsaction' => 'updateZone',
  1057. 'zone_id' => $zoneID,
  1058. 'records' => $zoneRecords,
  1059. )
  1060. );
  1061. if($result['result'] != 'success') {
  1062. return 'Error: ' . $result['message'];
  1063. }
  1064. return 'success';
  1065. }
  1066. /**
  1067. * Returns API Url .
  1068. *
  1069. * @param string $params common module parameters
  1070. *
  1071. * @see https://developers.whmcs.com/provisioning-modules/supported-functions/
  1072. *
  1073. * @return string $apiUrl
  1074. */
  1075. function getSiteBuilderApiURL($params) {
  1076. $httpPrefix = $params['serversecure'] ? 'https://' : 'http://';
  1077. $serverPort = $params['serverport'] ? ':' . $params['serverport'] . '/' : '/';
  1078. return $httpPrefix . $params['serverhostname'] . $serverPort;
  1079. }
  1080. /**
  1081. * Returns all sitenames of an account.
  1082. *
  1083. * @param string $params common module parameters
  1084. *
  1085. * @see https://developers.whmcs.com/provisioning-modules/supported-functions/
  1086. *
  1087. * @return array $sites array of sitenames
  1088. */
  1089. function getSites($serviceID) {
  1090. $sitesObj = Capsule::table('sitePro_site')
  1091. ->where('relid', $serviceID)
  1092. ->get();
  1093. $sites = [];
  1094. foreach($sitesObj as $site){
  1095. array_push($sites, $site->name);
  1096. }
  1097. return $sites;
  1098. }
  1099. /**
  1100. * Returns all names of enabled sites of an account.
  1101. *
  1102. * @param string $params common module parameters
  1103. *
  1104. * @see https://developers.whmcs.com/provisioning-modules/supported-functions/
  1105. *
  1106. * @return array $sites array of sitenames
  1107. */
  1108. function getSitesEnabled($serviceID) {
  1109. $sitesObj = Capsule::table('sitePro_site')
  1110. ->where('relid', $serviceID)
  1111. ->where('enabled', 1)
  1112. ->get();
  1113. $sites = [];
  1114. foreach($sitesObj as $site){
  1115. array_push($sites, $site->name);
  1116. }
  1117. return $sites;
  1118. }
  1119. /**
  1120. * Creates tables for account & site management if not exists
  1121. */
  1122. function siteBuilderCreateTables() {
  1123. // Create a new table.
  1124. if (!Capsule::schema()->hasTable('sitePro_acc')) {
  1125. try {
  1126. Capsule::schema()->create(
  1127. 'sitePro_acc',
  1128. function ($table) {
  1129. /** @var \Illuminate\Database\Schema\Blueprint $table */
  1130. $table->increments('id');
  1131. $table->string('account');
  1132. $table->integer('pid');
  1133. $table->boolean('enabled');
  1134. }
  1135. );
  1136. } catch (\Exception $e) {
  1137. echo "Unable to create sitePro_acc: {$e->getMessage()}";
  1138. }
  1139. }
  1140. if (!Capsule::schema()->hasTable('sitePro_site')) {
  1141. try {
  1142. Capsule::schema()->create(
  1143. 'sitePro_site',
  1144. function ($table) {
  1145. /** @var \Illuminate\Database\Schema\Blueprint $table */
  1146. $table->increments('id');
  1147. $table->integer('relid');
  1148. $table->string('name');
  1149. $table->boolean('enabled');
  1150. }
  1151. );
  1152. } catch (\Exception $e) {
  1153. echo "Unable to create sitePro_site: {$e->getMessage()}";
  1154. }
  1155. }
  1156. }