InterWorx.php 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416
  1. <?php
  2. namespace MGModule\DNSManager2\mgLibs\custom\dns\submodules;
  3. require 'InterWorx/InterworxAPI.php';
  4. use \MGModule\DNSManager2\mgLibs\custom\dns;
  5. use \MGModule\DNSManager2\mgLibs\custom\dns\exceptions;
  6. use \MGModule\DNSManager2\mgLibs\custom\dns\interfaces;
  7. use \MGModule\DNSManager2\mgLibs\custom\dns\utils\Patterns;
  8. use \MGModule\DNSManager2\mgLibs\custom\dns\submodules\InterWorx\InterworxAPI;
  9. class InterWorx extends dns\SubmoduleAbstract implements
  10. interfaces\SubmoduleIPInterface,
  11. interfaces\SubmoduleRDNSInterface,
  12. interfaces\SubmoduleTTLInterface,
  13. interfaces\SubmoduleImportInterface
  14. {
  15. public $configFields = array(
  16. 'serverusername' =>array (
  17. 'friendlyName' => 'Email',
  18. 'validators' => array(
  19. 'required' => 'required',
  20. )
  21. ),
  22. 'serverpassword' =>array (
  23. 'friendlyName' => 'User Password',
  24. 'type'=> 'password',
  25. ),
  26. 'serveraccesshash' =>array (
  27. 'friendlyName' => 'API Key',
  28. 'type'=> 'textarea',
  29. ),
  30. 'serverip' =>array (
  31. 'friendlyName' => 'Hostname/IP',
  32. 'validators' => array(
  33. 'required' => 'required',
  34. )
  35. ),
  36. 'serversecure' =>array (
  37. 'friendlyName' => 'Enable SSL',
  38. 'type'=> 'yesno',
  39. ),
  40. 'default_ip' =>array (
  41. 'friendlyName' => 'Default IP',
  42. 'validators' => array(
  43. 'required' => 'required',
  44. 'pattern' => Patterns::IP4_OR_IP6,
  45. )
  46. ),
  47. 'serverport' =>array (
  48. 'friendlyName' => 'Port',
  49. ),
  50. );
  51. public $availableTypes = array('A', 'AAAA', 'CNAME', 'MX', 'NAPTR', 'NS', 'PTR', 'SPF', 'SRV', 'TXT');
  52. public function testConnection() {
  53. $conn = $this->getConnectionToAPI();
  54. $res = $conn->nodeworx->users->list();
  55. if ($res['status'] != '0')
  56. {
  57. throw new exceptions\DNSSubmoduleException('Error - Authentication Error (NodeWorx)', dns\SubmoduleExceptionCodes::CONNECTION_PROBLEM);
  58. }else{
  59. return true;
  60. }
  61. }
  62. public function getRecords($recordType = false) {
  63. $conn = $this->getConnectionToAPI();
  64. $out = $conn->nodeworx->dns->record->queryRecords(array('domain' => $this->domain));
  65. $return = array();
  66. if ($out['status'] != '0'){
  67. throw new exceptions\DNSSubmoduleException('Unable to fetch records from server', dns\SubmoduleExceptionCodes::COMMAND_ERROR);
  68. }
  69. foreach ($out['payload'] as $key => $r) {
  70. if (in_array((string)$r->type, $recordType!==false ? array(strtoupper($recordType)) : $this->getAvailableRecordTypes()))
  71. {
  72. $r->line = $r->record_id;
  73. $r->name = $r->host;
  74. switch ((string)$r->type) {
  75. case 'A':
  76. $r->rdata = array('address' => (string)$r->target);
  77. break;
  78. case 'AAAA':
  79. $r->rdata = array('address' => (string)$r->target);
  80. break;
  81. case 'CNAME':
  82. $r->rdata = array('cname' => (string)$r->target);
  83. break;
  84. case 'MX':
  85. $rawRdata = explode(' ', (string)$r->target);
  86. $r->rdata = array('preference' => $rawRdata[0],
  87. 'exchange' => $rawRdata[1]);
  88. break;
  89. case 'NAPTR':
  90. $rawRdata = explode(' ', (string)$r->target);
  91. $r->rdata = array('order' => $rawRdata[0],
  92. 'preference' => $rawRdata[1],
  93. 'flags' => $rawRdata[2],
  94. 'services' => $rawRdata[3],
  95. 'regexp' => $rawRdata[4],
  96. 'replacement' => $rawRdata[5]);
  97. break;
  98. case 'NS':
  99. $r->rdata = array('nsdname' => (string)$r->target);
  100. break;
  101. case 'PTR':
  102. $r->rdata = array('ptrdname' => (string)$r->target);
  103. break;
  104. case 'SPF':
  105. $r->rdata = array('txtdata' => (string)$r->target);
  106. break;
  107. case 'SRV':
  108. $rawRdata = explode(' ', (string)$r->target);
  109. $r->rdata = array('priority' => $rawRdata[0],
  110. 'weight' => $rawRdata[1],
  111. 'port' => $rawRdata[2],
  112. 'target' => $rawRdata[3]);
  113. break;
  114. case 'TXT':
  115. $r->rdata = array('txtdata' => (string)$r->target);
  116. break;
  117. }
  118. $return[] = dns\record\Record::tryToCreateFromArray((array)$r);
  119. }
  120. }
  121. return $return;
  122. }
  123. public function addRecord(dns\record\Record $record)
  124. {
  125. $input = $record->toMergedArray(false);
  126. $input['domain'] = $this->domain;
  127. $conn = $this->getConnectionToAPI();
  128. $res = $conn->nodeworx->dns->zone->queryZones(array('domain' => $this->domain));
  129. $zoneid = $res['payload'][0]->zone_id;
  130. $params = array('zone_id' => $zoneid,
  131. 'host' => $record->nameToAbsolute($this->domain, false),
  132. 'ttl' => $input['ttl']);
  133. switch ($input['type']) {
  134. case 'A':
  135. $params['ipaddress'] = $input['address'];
  136. $result = $conn->nodeworx->dns->record->addA($params);
  137. break;
  138. case 'AAAA':
  139. $params['ipaddress'] = $input['address'];
  140. $result = $conn->nodeworx->dns->record->addAAAA($params);
  141. break;
  142. case 'CNAME':
  143. $params['alias'] = $input['cname'];
  144. $result = $conn->nodeworx->dns->record->addCNAME($params);
  145. break;
  146. case 'MX':
  147. $params['preference'] = $input['preference'];
  148. $params['mail_server'] = $input['exchange'];
  149. $result = $conn->nodeworx->dns->record->addMX($params);
  150. break;
  151. case 'NAPTR':
  152. $params['domain'] = $input['name'];
  153. $params['order'] = $input['order'];
  154. $params['preference'] = $input['preference'];
  155. $params['flag'] = $input['flags'];
  156. $params['service'] = $input['services'];
  157. $params['regex'] = $input['regexp'];
  158. $params['replacement'] = $input['replacement'];
  159. $result = $conn->nodeworx->dns->record->addNAPTR($params);
  160. break;
  161. case 'NS':
  162. $params['nameserver'] = $input['nsdname'];
  163. $result = $conn->nodeworx->dns->record->addNS($params);
  164. break;
  165. case 'PTR':
  166. if(strlen($input['name']) < 7 && isset($_POST['ip']) && $_POST['ip'] != '')
  167. {
  168. $input['name'] = $_POST['ip'];
  169. }
  170. $params['domain'] = $input['ptrdname'];
  171. $params['ip_data'] = $input['name'];
  172. $result = $conn->nodeworx->dns->record->addPTR($params);
  173. break;
  174. case 'SPF':
  175. $params['spf_record_value'] = $input['txtdata'];
  176. $result = $conn->nodeworx->dns->record->addSPF($params);
  177. break;
  178. case 'SRV':
  179. $requestdata = explode('.', $input['name']);
  180. $params['service'] = $requestdata[0];
  181. $params['protocol'] = $requestdata[1];
  182. $params['domain'] = $requestdata[2].'.'.$requestdata[3];
  183. $params['priority'] = $input['priority'];
  184. $params['weight'] = $input['weight'];
  185. $params['port'] = $input['port'];
  186. $params['target'] = $input['target'];
  187. $result = $conn->nodeworx->dns->record->addSRV($params);
  188. break;
  189. case 'TXT':
  190. $params['text'] = $input['txtdata'];
  191. $result = $conn->nodeworx->dns->record->addTXT($params);
  192. break;
  193. default:
  194. break;
  195. }
  196. $this->logAction('addRecord', $params, $record);
  197. if($result['status'] != 0)
  198. {
  199. throw new exceptions\DNSSubmoduleException($result['payload'], dns\SubmoduleExceptionCodes::COMMAND_ERROR);
  200. }
  201. return true;
  202. }
  203. public function editRecord(dns\record\Record $record) {
  204. $conn = $this->getConnectionToAPI();
  205. $records = $this->getRecords();
  206. if(empty($records))
  207. return false;
  208. $lines = array();
  209. foreach($records as $r) {
  210. $lines[$r->line] = $r;
  211. }
  212. if(!isset($lines[$record->line]) || !$record->isEqualTo($lines[$record->line])) {
  213. $input = $record->toMergedArray(false);
  214. $params = (array('record_id' => $input['line'],
  215. 'host' => substr($input['name'], 0, -1),
  216. 'ttl' => $input['ttl']));
  217. switch ($input['type']) {
  218. case 'A':
  219. $params['ipaddress'] = $input['address'];
  220. $result = $conn->nodeworx->dns->record->editA($params);
  221. break;
  222. case 'AAAA':
  223. $params['ipaddress'] = $input['address'];
  224. $result = $conn->nodeworx->dns->record->editAAAA($params);
  225. break;
  226. case 'CNAME':
  227. $params['alias'] = $input['cname'];
  228. $result = $conn->nodeworx->dns->record->editCNAME($params);
  229. break;
  230. case 'MX':
  231. $params['preference'] = $input['preference'];
  232. $params['mail_server'] = $input['exchange'];
  233. $result = $conn->nodeworx->dns->record->editMX($params);
  234. break;
  235. case 'NAPTR':
  236. $params['domain'] = substr($input['name'], 0, -1);
  237. $params['order'] = $input['order'];
  238. $params['preference'] = $input['preference'];
  239. $params['flag'] = $input['flags'];
  240. $params['service'] = $input['services'];
  241. $params['regex'] = $input['regexp'];
  242. $params['replacement'] = $input['replacement'];
  243. $result = $conn->nodeworx->dns->record->editNAPTR($params);
  244. break;
  245. case 'NS':
  246. $params['nameserver'] = $input['nsdname'];
  247. $result = $conn->nodeworx->dns->record->editNS($params);
  248. break;
  249. case 'PTR':
  250. $params['domain'] = $input['ptrdname'];
  251. // $params['ip_data'] = $this->domain;
  252. $result = $conn->nodeworx->dns->record->editPTR($params);
  253. break;
  254. case 'SPF':
  255. $params['spf_record_value'] = $input['txtdata'];
  256. $result = $conn->nodeworx->dns->record->editSPF($params);
  257. break;
  258. case 'SRV':
  259. $requestdata = explode('.', $input['name']);
  260. $params['service'] = $requestdata[0];
  261. $params['protocol'] = $requestdata[1];
  262. $params['domain'] = $requestdata[2].'.'.$requestdata[3];
  263. $params['priority'] = $input['priority'];
  264. $params['weight'] = $input['weight'];
  265. $params['port'] = $input['port'];
  266. $params['target'] = $input['target'];
  267. $result = $conn->nodeworx->dns->record->editSRV($params);
  268. break;
  269. case 'TXT':
  270. $params['text'] = $input['txtdata'];
  271. $result = $conn->nodeworx->dns->record->editTXT($params);
  272. break;
  273. default:
  274. break;
  275. }
  276. $this->logAction('editRecord', $params, $record);
  277. if($result['status'] != 0)
  278. {
  279. throw new exceptions\DNSSubmoduleException($result['payload'], dns\SubmoduleExceptionCodes::COMMAND_ERROR);
  280. }
  281. }
  282. }
  283. public function deleteRecord(dns\record\Record $record) {
  284. $conn = $this->getConnectionToAPI();
  285. $result = $conn->nodeworx->dns->record->delete(array('record_id' => $record['line']));
  286. if($result['status'] != 0)
  287. {
  288. throw new exceptions\DNSSubmoduleException($result['payload'], dns\SubmoduleExceptionCodes::INVALID_PARAMETERS);
  289. }
  290. }
  291. public function zoneExists() {
  292. try {
  293. $conn = $this->getConnectionToAPI();
  294. $out = $conn->nodeworx->dns->zone->listZones();
  295. } catch (exceptions\DNSSubmoduleException $e) {
  296. if($e->getCode() == dns\SubmoduleExceptionCodes::COMMAND_ERROR) {
  297. return false;
  298. }
  299. throw $e;
  300. }
  301. foreach($out['payload'] as $zone) {
  302. if((string)$zone->domain == $this->domain) {
  303. return true;
  304. }
  305. }
  306. return false;
  307. }
  308. public function activateZone() {
  309. if($this->ip != '') {
  310. if(!filter_var($this->ip, FILTER_VALIDATE_IP)) {
  311. throw new exceptions\DNSSubmoduleException('IP is not valid!', dns\SubmoduleExceptionCodes::INVALID_PARAMETERS);
  312. }
  313. } else {
  314. $this->ip = $this->config['default_ip'];
  315. }
  316. $params = array(
  317. 'domain' => $this->domain,
  318. 'ipaddr' => $this->ip
  319. );
  320. if($this->config['template'] != "")
  321. $params['template'] = $this->config['template'];
  322. try {
  323. $conn = $this->getConnectionToAPI();
  324. $result = $conn->nodeworx->dns->zone->add($params);
  325. if($result['status'] != 0)
  326. {
  327. throw new exceptions\DNSSubmoduleException($result['payload'], dns\SubmoduleExceptionCodes::INVALID_PARAMETERS);
  328. }
  329. } catch (exceptions\DNSSubmoduleException $e) {
  330. throw $e;
  331. }
  332. }
  333. public function terminateZone() {
  334. $conn = $this->getConnectionToAPI();
  335. $res = $conn->nodeworx->dns->zone->queryZones(array('domain' => $this->domain));
  336. $zoneid = $res['payload'][0]->zone_id;
  337. $result = $conn->nodeworx->dns->zone->delete(array('zone_id' => $zoneid));
  338. if($result['status'] != 0)
  339. {
  340. throw new exceptions\DNSSubmoduleException($result['payload'], dns\SubmoduleExceptionCodes::INVALID_PARAMETERS);
  341. }
  342. }
  343. public function getZones()
  344. {
  345. $out = array();
  346. $conn = $this->getConnectionToAPI();
  347. $res = $conn->nodeworx->dns->zone->listZones();
  348. if($res['status'] != 0)
  349. {
  350. throw new exceptions\DNSSubmoduleException($res['payload'], dns\SubmoduleExceptionCodes::INVALID_PARAMETERS);
  351. }
  352. foreach($res['payload'] as $zone)
  353. {
  354. $out[$zone->domain] = '';
  355. }
  356. return $out;
  357. }
  358. private function getConnectionToAPI()
  359. {
  360. $conn = new InterworxAPI();
  361. $doRequest = $conn->getInstance($this->config);
  362. return $doRequest;
  363. }
  364. private function logAction($action, $request, $response)
  365. {
  366. $addonConfig = \MGModule\DNSManager2\addon::config();
  367. logmodulecall(
  368. $addonConfig['name'],
  369. 'InterWorx '.($action),
  370. array($request),
  371. array($response),
  372. null,
  373. array($this->config['hostname'], $this->config['hostname'], $this->config['hash'])
  374. );
  375. }
  376. }