MyMetricProvider.php 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357
  1. <?php
  2. namespace ThurData\Servers\KerioEmail\App\Libs\Metrics;
  3. use ThurData\Servers\HetznerVps\App\Libs\HetznerVps\Api;
  4. use ThurData\Servers\HetznerVps\App\Libs\HetznerVps\Api\Constants;
  5. use ThurData\Servers\KerioEmail\App\Helpers\KerioManager;
  6. use ThurData\Servers\KerioEmail\App\Enums\Size;
  7. use mysql_xdevapi\DocResult;
  8. use WHMCS\UsageBilling\Contracts\Metrics\MetricInterface;
  9. use WHMCS\UsageBilling\Contracts\Metrics\ProviderInterface;
  10. use WHMCS\UsageBilling\Metrics\Metric;
  11. use WHMCS\UsageBilling\Metrics\Units\WholeNumber;
  12. use WHMCS\UsageBilling\Metrics\Usage;
  13. use WHMCS\UsageBilling\Metrics\Units\GigaBytes;
  14. use ThurData\Servers\KerioEmail\Api\KerioWhmcs;
  15. class MyMetricProvider implements ProviderInterface
  16. {
  17. private $moduleParams = [];
  18. public function __construct($moduleParams)
  19. {
  20. $this->moduleParams = $moduleParams;
  21. }
  22. public function metrics()
  23. {
  24. return [
  25. new Metric(
  26. 'mailboxes',
  27. 'Email Accounts',
  28. MetricInterface::TYPE_SNAPSHOT
  29. ),
  30. new Metric(
  31. 'aliases',
  32. 'Email Aliases',
  33. MetricInterface::TYPE_SNAPSHOT
  34. ),
  35. new Metric(
  36. 'distributionLists',
  37. 'Distribution Lists',
  38. MetricInterface::TYPE_SNAPSHOT
  39. ),
  40. new Metric(
  41. 'domainAliases',
  42. 'Domain Aliases',
  43. MetricInterface::TYPE_SNAPSHOT
  44. ),
  45. new Metric(
  46. 'storage',
  47. 'Storage',
  48. MetricInterface::TYPE_SNAPSHOT,
  49. new GigaBytes()
  50. )
  51. ];
  52. }
  53. public function usage()
  54. {
  55. $api = new KerioWhmcs('whmcsKerioEmail', 'Thurdata', '1.0');
  56. try {
  57. $api->login($this->moduleParams['serverhostname'], $this->moduleParams['serverusername'], $this->moduleParams['serverpassword']);
  58. $domains = $api->getDomains(['id','name','aliasList']);
  59. } catch (KerioApiException $error) {
  60. logModuleCall(
  61. 'kerioEmail',
  62. __FUNCTION__,
  63. $error,
  64. 'Debug Error',
  65. $error->getMessage()
  66. );
  67. return ['error' => $error->getMessage()];
  68. }
  69. $usage = [];
  70. foreach ($domains as $domain)
  71. {
  72. $domainName = $domain['name'];
  73. $domainID = $domain['id'];
  74. $countOfDomainAliases = count($domain['aliasList']);
  75. try
  76. {
  77. $fields = array(
  78. 'loginName',
  79. 'fullName',
  80. 'consumedSize'
  81. );
  82. $mailboxes = $api->getUsers($fields,$domainID);
  83. $countOfMailboxes = count($mailboxes);
  84. $totalUsage = 0;
  85. if ($countOfMailboxes > 0) {
  86. foreach ($mailboxes as $mailboxe) {
  87. switch($mailboxe['consumedSize']['units']) {
  88. case 'Bytes' :
  89. $usage = $mailboxe['consumedSize']['value']/1024/1024;
  90. break;
  91. case 'KiloBytes' :
  92. $usage = $mailboxe['consumedSize']['value']/1024;
  93. break;
  94. case 'MegaBytes' :
  95. $usage = $mailboxe['consumedSize']['value'];
  96. break;
  97. case 'GigaBytes' :
  98. $usage = $mailboxe['consumedSize']['value']*1024;
  99. break;
  100. }
  101. $totalUsage += $usage;
  102. }
  103. }
  104. $storage = $totalUsage == 0 ? 0 : round($totalUsage);
  105. } catch (KerioApiException $error) {
  106. logModuleCall(
  107. 'kerioEmail',
  108. __FUNCTION__,
  109. $error,
  110. 'Debug Error',
  111. $error->getMessage()
  112. );
  113. return ['error' => $error->getMessage()];
  114. }
  115. try
  116. {
  117. $fields = array(
  118. "id",
  119. "name");
  120. $mailingLists = $api->getMailingLists($fields,$domainID);
  121. $countOfDistributionList = count($mailingLists);
  122. } catch (KerioApiException $error) {
  123. logModuleCall(
  124. 'kerioEmail',
  125. __FUNCTION__,
  126. $error,
  127. 'Debug Error',
  128. $error->getMessage()
  129. );
  130. return ['error' => $error->getMessage()];
  131. }
  132. try
  133. {
  134. $fields = array(
  135. "id",
  136. "name");
  137. $aliases = $api->getAliases($fields,$domainID);
  138. $countOfEmailAliases = count($aliases);
  139. } catch (KerioApiException $error) {
  140. logModuleCall(
  141. 'kerioEmail',
  142. __FUNCTION__,
  143. $error,
  144. 'Debug Error',
  145. $error->getMessage()
  146. );
  147. return ['error' => $error->getMessage()];
  148. }
  149. $domainData = [
  150. 'mailboxes' => $countOfMailboxes,
  151. 'distributionLists' => $countOfDistributionList,
  152. 'aliases' => $countOfEmailAliases,
  153. 'domainAliases' => $countOfDomainAliases,
  154. 'storage' => $storage,
  155. ];
  156. $usage[$domainName] = $this->wrapUserData($domainData);
  157. }
  158. $api->logout();
  159. return $usage;
  160. }
  161. public function tenantUsage($tenant)
  162. {
  163. $api = new KerioWhmcs('whmcsKerioEmail', 'Thurdata', '1.0');
  164. try {
  165. $api->login($this->moduleParams['serverhostname'], $this->moduleParams['serverusername'], $this->moduleParams['serverpassword']);
  166. $domains = $api->getDomains(['id','name','aliasList']);
  167. } catch (KerioApiException $error) {
  168. logModuleCall(
  169. 'kerioEmail',
  170. __FUNCTION__,
  171. $error,
  172. 'Debug Error',
  173. $error->getMessage()
  174. );
  175. return ['error' => $error->getMessage()];
  176. }
  177. $usage = [];
  178. foreach ($domains as $domain)
  179. {
  180. $domainName = $domain['name'];
  181. $domainID = $domain['id'];
  182. $countOfDomainAliases = count($domain['aliasList']);
  183. try
  184. {
  185. $fields = array(
  186. 'loginName',
  187. 'fullName',
  188. 'consumedSize'
  189. );
  190. $mailboxes = $api->getUsers($fields,$domainID);
  191. $countOfMailboxes = count($mailboxes);
  192. $totalUsage = 0;
  193. if ($countOfMailboxes > 0) {
  194. foreach ($mailboxes as $mailboxe) {
  195. switch($mailboxe['consumedSize']['units']) {
  196. case 'Bytes' :
  197. $usage = $mailboxe['consumedSize']['value']/1024/1024;
  198. break;
  199. case 'KiloBytes' :
  200. $usage = $mailboxe['consumedSize']['value']/1024;
  201. break;
  202. case 'MegaBytes' :
  203. $usage = $mailboxe['consumedSize']['value'];
  204. break;
  205. case 'GigaBytes' :
  206. $usage = $mailboxe['consumedSize']['value']*1024;
  207. break;
  208. }
  209. $totalUsage += $usage;
  210. }
  211. }
  212. $storage = $totalUsage == 0 ? 0 : round($totalUsage);
  213. } catch (KerioApiException $error) {
  214. logModuleCall(
  215. 'kerioEmail',
  216. __FUNCTION__,
  217. $error,
  218. 'Debug Error',
  219. $error->getMessage()
  220. );
  221. return ['error' => $error->getMessage()];
  222. }
  223. try
  224. {
  225. $fields = array(
  226. "id",
  227. "name");
  228. $mailingLists = $api->getMailingLists($fields,$domainID);
  229. $countOfDistributionList = count($mailingLists);
  230. } catch (KerioApiException $error) {
  231. logModuleCall(
  232. 'kerioEmail',
  233. __FUNCTION__,
  234. $error,
  235. 'Debug Error',
  236. $error->getMessage()
  237. );
  238. return ['error' => $error->getMessage()];
  239. }
  240. try
  241. {
  242. $fields = array(
  243. "id",
  244. "name");
  245. $aliases = $api->getAliases($fields,$domainID);
  246. $countOfEmailAliases = count($aliases);
  247. } catch (KerioApiException $error) {
  248. logModuleCall(
  249. 'kerioEmail',
  250. __FUNCTION__,
  251. $error,
  252. 'Debug Error',
  253. $error->getMessage()
  254. );
  255. return ['error' => $error->getMessage()];
  256. }
  257. $domainData = [
  258. 'mailboxes' => $countOfMailboxes,
  259. 'distributionLists' => $countOfDistributionList,
  260. 'aliases' => $countOfEmailAliases,
  261. 'domainAliases' => $countOfDomainAliases,
  262. 'storage' => $storage,
  263. ];
  264. $usage[$domainName] = $this->wrapUserData($domainData);
  265. }
  266. $api->logout();
  267. return $usage;
  268. }
  269. private function wrapUserData($data)
  270. {
  271. $wrapped = [];
  272. foreach ($this->metrics() as $metric) {
  273. $key = $metric->systemName();
  274. if ($data[$key]) {
  275. $value = $data[$key];
  276. $metric = $metric->withUsage(
  277. new Usage($value)
  278. );
  279. }
  280. $wrapped[] = $metric;
  281. }
  282. return $wrapped;
  283. }
  284. private function getAccounts($tenant)
  285. {
  286. $accounts =(new KerioManager())
  287. ->getApiByServer($this->moduleParams['serverid'])
  288. ->soap
  289. ->repository()
  290. ->accounts()
  291. ->getByDomainName($tenant);
  292. return $accounts;
  293. }
  294. private function getDomainAliases($tenant)
  295. {
  296. $domainAliases =(new KerioManager())
  297. ->getApiByServer($this->moduleParams['serverid'])
  298. ->soap
  299. ->repository()
  300. ->domains
  301. ->getAliases($tenant);
  302. return $domainAliases;
  303. }
  304. private function getDomainUsage($tenant)
  305. {
  306. $accounts =(new KerioManager())
  307. ->getApiByServer($this->moduleParams['serverid'])
  308. ->soap
  309. ->repository()
  310. ->accounts
  311. ->getUsages($tenant);
  312. $totalUsage = 0;
  313. foreach ($accounts as $account)
  314. {
  315. $usage = $account->getUsed();
  316. $totalUsage += $usage;
  317. }
  318. return $totalUsage;
  319. }
  320. private function getDistributionList($tenant)
  321. {
  322. $distributionList =(new KerioManager())
  323. ->getApiByServer($this->moduleParams['serverid'])
  324. ->soap
  325. ->repository()
  326. ->lists
  327. ->getAllDistributionListsByDomain($tenant);
  328. return $distributionList;
  329. }
  330. }