class_logging.inc

Go to the documentation of this file.

<?php

/*
  This code is part of FusionDirectory (http://www.fusiondirectory.org/)
  Copyright (C) 2007  Fabian Hickert
  Copyright (C) 2011-2016  FusionDirectory

  This program is free software; you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation; either version 2 of the License, or
  (at your option) any later version.

  This program is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with this program; if not, write to the Free Software
  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.
*/

class logging
{
  static $validActions = ['modify','create','remove','copy','snapshot','security','error'];

  static function log (string $action, string $objecttype, string $object, array $changes = [], string $result = '')
  {
    global $config, $ui;

    /* Create data object */
    $entry = [
      'timestamp'   => microtime(TRUE),
      'action'      => $action,
      'objecttype'  => $objecttype,
      'object'      => $object,
      'changes'     => $changes,
      'result'      => $result
    ];
    if (isset($ui->dn) && !empty($ui->dn)) {
      $entry['user']  = $ui->dn;
    } elseif (isset($_SERVER['REMOTE_ADDR'])) {
      $entry['user'] = $_SERVER['REMOTE_ADDR'];
    } else {
      $entry['user'] = 'unknown';
    }

    /* Check if all given values are valid */
    $msgs = static::check($entry);
    if (count($msgs)) {
      foreach ($msgs as $msg) {
        trigger_error('Logging failed, reason was: '.$msg);
        $error = new FusionDirectoryError(htmlescape(sprintf(_('Logging failed: %s'), $msg)));
        $error->display();
      }
    } else {
      if (is_object($config) && preg_match('/true/i', $config->get_cfg_value('logging', ''))) {
        static::log_into_syslog($entry);
        if (in_array($action, $config->get_cfg_value('auditActions', []))) {
          static::log_into_ldap($entry);
        }
      }
    }
  }

  static function debug (int $level, int $line, string $function, string $file, $data, string $info = '')
  {
    global $config;

    static $first = TRUE;

    if (session::get('DEBUGLEVEL') & $level) {
      $output = '';
      if ($first) {
        $output .= '<div id="debug-handling" class="notice">'.
              '<img src="geticon.php?context=status&amp;icon=dialog-information&amp;size=22" alt="Information" style="vertical-align:middle;margin-right:.2em;"/>'.
              'There is some debug output '.
              '<button onClick="javascript:$$(\'div.debug_div\').each(function (a) { a.toggle(); });">Toggle</button>'.
            '</div>';
        $first = FALSE;
      }
      $logline = "DEBUG[$level] ";
      if ($function != '') {
        $logline .= "($file:$function():$line) - $info: ";
      } else {
        $logline .= "($file:$line) - $info: ";
      }
      $output .= '<div class="debug_div">';
      $output .= $logline;
      if (is_array($data)) {
        $output .= print_a($data, TRUE);
        $logline .= print_r($data, TRUE);
      } else {
        $output   .= "'$data'";
        $logline  .= "'$data'";
      }
      $output .= "</div>\n";

      if (is_object($config) && preg_match('/true/i', $config->get_cfg_value('debugLogging', ''))) {
        fusiondirectory_log($logline);
      }

      if (($_SERVER['REQUEST_METHOD'] == 'POST') && preg_match('/index.php$/', $_SERVER['REQUEST_URI'])) {
        return;
      }

      echo $output;
    }
  }

  static protected function check ($entry = [])
  {
    $msgs = [];

    if (!isset($entry['action']) || !in_array($entry['action'], static::$validActions)) {
      $msgs[] = sprintf(_('Invalid option "%s" specified!'), $entry['action']);
    }

    if (!isset($entry['objecttype']) || empty($entry['objecttype'])) {
      $msgs[] = _('Specified objectType is empty or invalid!');
    }

    return $msgs;
  }

  /*
   * \brief This function is used to into the systems syslog
   *
   * \param Array $entry Entry to be loged
   */
  static protected function log_into_syslog ($entry)
  {
    $str = '';
    if (empty($entry['object']) && empty($entry['changes'])) {
      $str = '('.$entry['action'].') '.$entry['objecttype'].': '.$entry['result'];
    } else {
      $str = '('.$entry['action'].') '.$entry['object'].' of type '.$entry['objecttype'].' '.implode(',', $entry['changes']).': '.$entry['result'];
    }
    fusiondirectory_log($str);
  }

  /*
   * \brief This function is used to into the ldap for audit plugin
   *
   * \param Array $entry Entry to be logged
   */
  static protected function log_into_ldap ($entry)
  {
    global $config;
    if ($entry['objecttype'] == 'plugin/auditEvent') {
      /* Avoid infinite loop */
      return;
    }
    if (empty($entry['object'])) {
      $entry['object'] = 'none';
    }
    try {
      $tabObject = objects::create('auditEvent');
      $baseObject = $tabObject->getBaseObject();
      $baseObject->fdAuditDateTime    = DateTime::createFromFormat('U.u', number_format($entry['timestamp'], 6, '.', ''));
      $baseObject->fdAuditAction      = $entry['action'];
      $baseObject->fdAuditAuthorDN    = $entry['user'];
      $baseObject->fdAuditObjectType  = $entry['objecttype'];
      $baseObject->fdAuditObject      = $entry['object'];
      $baseObject->fdAuditAttributes  = $entry['changes'];
      $baseObject->fdAuditResult      = $entry['result'];
      $baseObject->base               = $config->current['BASE'];
      $errors = $tabObject->save();
      if (!empty($errors)) {
        msg_dialog::displayChecks($errors);
      }
    } catch (FusionDirectoryException $e) {
      $error = new FusionDirectoryError(
        htmlescape(sprintf(
          _('Failed to log event (%s - %s): %s'),
          $entry['action'],
          $entry['objecttype'],
          $e->getMessage()
        )),
        0,
        $e
      );
      $error->display();
    }
  }
}