Log.php 9.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338
  1. <?php
  2. declare(strict_types=1);
  3. /**
  4. * @copyright Copyright (c) 2016, ownCloud, Inc.
  5. *
  6. * @author Arthur Schiwon <blizzz@arthur-schiwon.de>
  7. * @author Bart Visscher <bartv@thisnet.nl>
  8. * @author Bernhard Posselt <dev@bernhard-posselt.com>
  9. * @author Joas Schilling <coding@schilljs.com>
  10. * @author Johannes Schlichenmaier <johannes@schlichenmaier.info>
  11. * @author Juan Pablo Villafáñez <jvillafanez@solidgear.es>
  12. * @author Lukas Reschke <lukas@statuscode.ch>
  13. * @author Morris Jobke <hey@morrisjobke.de>
  14. * @author Olivier Paroz <github@oparoz.com>
  15. * @author Robin Appelman <robin@icewind.nl>
  16. * @author Thomas Müller <thomas.mueller@tmit.eu>
  17. * @author Thomas Pulzer <t.pulzer@kniel.de>
  18. * @author Victor Dubiniuk <dubiniuk@owncloud.com>
  19. *
  20. * @license AGPL-3.0
  21. *
  22. * This code is free software: you can redistribute it and/or modify
  23. * it under the terms of the GNU Affero General Public License, version 3,
  24. * as published by the Free Software Foundation.
  25. *
  26. * This program is distributed in the hope that it will be useful,
  27. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  28. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  29. * GNU Affero General Public License for more details.
  30. *
  31. * You should have received a copy of the GNU Affero General Public License, version 3,
  32. * along with this program. If not, see <http://www.gnu.org/licenses/>
  33. *
  34. */
  35. namespace OC;
  36. use InterfaSys\LogNormalizer\Normalizer;
  37. use OC\Log\ExceptionSerializer;
  38. use OCP\Log\IFileBased;
  39. use OCP\Log\IWriter;
  40. use OCP\ILogger;
  41. use OCP\Support\CrashReport\IRegistry;
  42. use OCP\Util;
  43. /**
  44. * logging utilities
  45. *
  46. * This is a stand in, this should be replaced by a Psr\Log\LoggerInterface
  47. * compatible logger. See https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-3-logger-interface.md
  48. * for the full interface specification.
  49. *
  50. * MonoLog is an example implementing this interface.
  51. */
  52. class Log implements ILogger {
  53. /** @var IWriter */
  54. private $logger;
  55. /** @var SystemConfig */
  56. private $config;
  57. /** @var boolean|null cache the result of the log condition check for the request */
  58. private $logConditionSatisfied = null;
  59. /** @var Normalizer */
  60. private $normalizer;
  61. /** @var IRegistry */
  62. private $crashReporters;
  63. /**
  64. * @param IWriter $logger The logger that should be used
  65. * @param SystemConfig $config the system config object
  66. * @param Normalizer|null $normalizer
  67. * @param IRegistry|null $registry
  68. */
  69. public function __construct(IWriter $logger, SystemConfig $config = null, $normalizer = null, IRegistry $registry = null) {
  70. // FIXME: Add this for backwards compatibility, should be fixed at some point probably
  71. if ($config === null) {
  72. $config = \OC::$server->getSystemConfig();
  73. }
  74. $this->config = $config;
  75. $this->logger = $logger;
  76. if ($normalizer === null) {
  77. $this->normalizer = new Normalizer();
  78. } else {
  79. $this->normalizer = $normalizer;
  80. }
  81. $this->crashReporters = $registry;
  82. }
  83. /**
  84. * System is unusable.
  85. *
  86. * @param string $message
  87. * @param array $context
  88. * @return void
  89. */
  90. public function emergency(string $message, array $context = []) {
  91. $this->log(ILogger::FATAL, $message, $context);
  92. }
  93. /**
  94. * Action must be taken immediately.
  95. *
  96. * Example: Entire website down, database unavailable, etc. This should
  97. * trigger the SMS alerts and wake you up.
  98. *
  99. * @param string $message
  100. * @param array $context
  101. * @return void
  102. */
  103. public function alert(string $message, array $context = []) {
  104. $this->log(ILogger::ERROR, $message, $context);
  105. }
  106. /**
  107. * Critical conditions.
  108. *
  109. * Example: Application component unavailable, unexpected exception.
  110. *
  111. * @param string $message
  112. * @param array $context
  113. * @return void
  114. */
  115. public function critical(string $message, array $context = []) {
  116. $this->log(ILogger::ERROR, $message, $context);
  117. }
  118. /**
  119. * Runtime errors that do not require immediate action but should typically
  120. * be logged and monitored.
  121. *
  122. * @param string $message
  123. * @param array $context
  124. * @return void
  125. */
  126. public function error(string $message, array $context = []) {
  127. $this->log(ILogger::ERROR, $message, $context);
  128. }
  129. /**
  130. * Exceptional occurrences that are not errors.
  131. *
  132. * Example: Use of deprecated APIs, poor use of an API, undesirable things
  133. * that are not necessarily wrong.
  134. *
  135. * @param string $message
  136. * @param array $context
  137. * @return void
  138. */
  139. public function warning(string $message, array $context = []) {
  140. $this->log(ILogger::WARN, $message, $context);
  141. }
  142. /**
  143. * Normal but significant events.
  144. *
  145. * @param string $message
  146. * @param array $context
  147. * @return void
  148. */
  149. public function notice(string $message, array $context = []) {
  150. $this->log(ILogger::INFO, $message, $context);
  151. }
  152. /**
  153. * Interesting events.
  154. *
  155. * Example: User logs in, SQL logs.
  156. *
  157. * @param string $message
  158. * @param array $context
  159. * @return void
  160. */
  161. public function info(string $message, array $context = []) {
  162. $this->log(ILogger::INFO, $message, $context);
  163. }
  164. /**
  165. * Detailed debug information.
  166. *
  167. * @param string $message
  168. * @param array $context
  169. * @return void
  170. */
  171. public function debug(string $message, array $context = []) {
  172. $this->log(ILogger::DEBUG, $message, $context);
  173. }
  174. /**
  175. * Logs with an arbitrary level.
  176. *
  177. * @param int $level
  178. * @param string $message
  179. * @param array $context
  180. * @return void
  181. */
  182. public function log(int $level, string $message, array $context = []) {
  183. $minLevel = $this->getLogLevel($context);
  184. array_walk($context, [$this->normalizer, 'format']);
  185. $app = $context['app'] ?? 'no app in context';
  186. // interpolate $message as defined in PSR-3
  187. $replace = [];
  188. foreach ($context as $key => $val) {
  189. $replace['{' . $key . '}'] = $val;
  190. }
  191. $message = strtr($message, $replace);
  192. if ($level >= $minLevel) {
  193. $this->writeLog($app, $message, $level);
  194. }
  195. if (!is_null($this->crashReporters)) {
  196. $this->crashReporters->delegateBreadcrumb($message, 'log', $context);
  197. }
  198. }
  199. private function getLogLevel($context) {
  200. $logCondition = $this->config->getValue('log.condition', []);
  201. /**
  202. * check for a special log condition - this enables an increased log on
  203. * a per request/user base
  204. */
  205. if ($this->logConditionSatisfied === null) {
  206. // default to false to just process this once per request
  207. $this->logConditionSatisfied = false;
  208. if (!empty($logCondition)) {
  209. // check for secret token in the request
  210. if (isset($logCondition['shared_secret'])) {
  211. $request = \OC::$server->getRequest();
  212. if ($request->getMethod() === 'PUT' &&
  213. strpos($request->getHeader('Content-Type'), 'application/x-www-form-urlencoded') === false &&
  214. strpos($request->getHeader('Content-Type'), 'application/json') === false) {
  215. $logSecretRequest = '';
  216. } else {
  217. $logSecretRequest = $request->getParam('log_secret', '');
  218. }
  219. // if token is found in the request change set the log condition to satisfied
  220. if ($request && hash_equals($logCondition['shared_secret'], $logSecretRequest)) {
  221. $this->logConditionSatisfied = true;
  222. }
  223. }
  224. // check for user
  225. if (isset($logCondition['users'])) {
  226. $user = \OC::$server->getUserSession()->getUser();
  227. // if the user matches set the log condition to satisfied
  228. if ($user !== null && in_array($user->getUID(), $logCondition['users'], true)) {
  229. $this->logConditionSatisfied = true;
  230. }
  231. }
  232. }
  233. }
  234. // if log condition is satisfied change the required log level to DEBUG
  235. if ($this->logConditionSatisfied) {
  236. return ILogger::DEBUG;
  237. }
  238. if (isset($context['app'])) {
  239. $app = $context['app'];
  240. /**
  241. * check log condition based on the context of each log message
  242. * once this is met -> change the required log level to debug
  243. */
  244. if (!empty($logCondition)
  245. && isset($logCondition['apps'])
  246. && in_array($app, $logCondition['apps'], true)) {
  247. return ILogger::DEBUG;
  248. }
  249. }
  250. return min($this->config->getValue('loglevel', ILogger::WARN), ILogger::FATAL);
  251. }
  252. /**
  253. * Logs an exception very detailed
  254. *
  255. * @param \Exception|\Throwable $exception
  256. * @param array $context
  257. * @return void
  258. * @since 8.2.0
  259. */
  260. public function logException(\Throwable $exception, array $context = []) {
  261. $app = $context['app'] ?? 'no app in context';
  262. $level = $context['level'] ?? ILogger::ERROR;
  263. $serializer = new ExceptionSerializer();
  264. $data = $serializer->serializeException($exception);
  265. $data['CustomMessage'] = $context['message'] ?? '--';
  266. $minLevel = $this->getLogLevel($context);
  267. array_walk($context, [$this->normalizer, 'format']);
  268. if ($level >= $minLevel) {
  269. if (!$this->logger instanceof IFileBased) {
  270. $data = json_encode($data, JSON_PARTIAL_OUTPUT_ON_ERROR);
  271. }
  272. $this->writeLog($app, $data, $level);
  273. }
  274. $context['level'] = $level;
  275. if (!is_null($this->crashReporters)) {
  276. $this->crashReporters->delegateReport($exception, $context);
  277. }
  278. }
  279. /**
  280. * @param string $app
  281. * @param string|array $entry
  282. * @param int $level
  283. */
  284. protected function writeLog(string $app, $entry, int $level) {
  285. $this->logger->write($app, $entry, $level);
  286. }
  287. public function getLogPath():string {
  288. if($this->logger instanceof IFileBased) {
  289. return $this->logger->getLogFilePath();
  290. }
  291. throw new \RuntimeException('Log implementation has no path');
  292. }
  293. }