Logger.php 2.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107
  1. <?php
  2. /**
  3. * Copyright © Magento, Inc. All rights reserved.
  4. * See COPYING.txt for license details.
  5. */
  6. namespace Magento\Payment\Model\Method;
  7. use Magento\Payment\Gateway\ConfigInterface;
  8. use Psr\Log\LoggerInterface;
  9. /**
  10. * Class Logger for payment related information (request, response, etc.) which is used for debug.
  11. *
  12. * @api
  13. * @since 100.0.2
  14. */
  15. class Logger
  16. {
  17. const DEBUG_KEYS_MASK = '****';
  18. /**
  19. * @var LoggerInterface
  20. */
  21. protected $logger;
  22. /**
  23. * @var ConfigInterface
  24. */
  25. private $config;
  26. /**
  27. * @param LoggerInterface $logger
  28. * @param ConfigInterface|null $config
  29. */
  30. public function __construct(
  31. LoggerInterface $logger,
  32. ConfigInterface $config = null
  33. ) {
  34. $this->logger = $logger;
  35. $this->config = $config;
  36. }
  37. /**
  38. * Logs payment related information used for debug
  39. *
  40. * @param array $data
  41. * @param array|null $maskKeys
  42. * @param bool|null $forceDebug
  43. * @return void
  44. */
  45. public function debug(array $data, array $maskKeys = null, $forceDebug = null)
  46. {
  47. $maskKeys = $maskKeys !== null ? $maskKeys : $this->getDebugReplaceFields();
  48. $debugOn = $forceDebug !== null ? $forceDebug : $this->isDebugOn();
  49. if ($debugOn === true) {
  50. $data = $this->filterDebugData(
  51. $data,
  52. $maskKeys
  53. );
  54. $this->logger->debug(var_export($data, true));
  55. }
  56. }
  57. /**
  58. * Returns configured keys to be replaced with mask
  59. *
  60. * @return array
  61. */
  62. private function getDebugReplaceFields()
  63. {
  64. if ($this->config && $this->config->getValue('debugReplaceKeys')) {
  65. return explode(',', $this->config->getValue('debugReplaceKeys'));
  66. }
  67. return [];
  68. }
  69. /**
  70. * Whether debug is enabled in configuration
  71. *
  72. * @return bool
  73. */
  74. private function isDebugOn()
  75. {
  76. return $this->config && (bool)$this->config->getValue('debug');
  77. }
  78. /**
  79. * Recursive filter data by private conventions
  80. *
  81. * @param array $debugData
  82. * @param array $debugReplacePrivateDataKeys
  83. * @return array
  84. */
  85. protected function filterDebugData(array $debugData, array $debugReplacePrivateDataKeys)
  86. {
  87. $debugReplacePrivateDataKeys = array_map('strtolower', $debugReplacePrivateDataKeys);
  88. foreach (array_keys($debugData) as $key) {
  89. if (in_array(strtolower($key), $debugReplacePrivateDataKeys)) {
  90. $debugData[$key] = self::DEBUG_KEYS_MASK;
  91. } elseif (is_array($debugData[$key])) {
  92. $debugData[$key] = $this->filterDebugData($debugData[$key], $debugReplacePrivateDataKeys);
  93. }
  94. }
  95. return $debugData;
  96. }
  97. }