MyMetricProvider.php 9.5 KB

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