system_log.php

Go to the documentation of this file.

<?php
function get_system_log($by_user = "", $event = "", $class = "", $type = "", $subtype = "", $limit = null,
                        $offset = 0, $count = false, $timebefore = 0, $timeafter = 0, $object_id = 0,
                        $ip_address = "") {

    global $CONFIG;

    $by_user_orig = $by_user;
    if (is_array($by_user) && sizeof($by_user) > 0) {
        foreach ($by_user as $key => $val) {
            $by_user[$key] = (int) $val;
        }
    } else {
        $by_user = (int)$by_user;
    }
    
    $event = sanitise_string($event);
    $class = sanitise_string($class);
    $type = sanitise_string($type);
    $subtype = sanitise_string($subtype);
    $ip_address = sanitise_string($ip_address);
    if ($limit === null) {
        $limit = elgg_get_config('default_limit');
    }
    $limit = (int)$limit;
    $offset = (int)$offset;

    $where = array();

    if ($by_user_orig !== "" && $by_user_orig !== false && $by_user_orig !== null) {
        if (is_int($by_user)) {
            $where[] = "performed_by_guid=$by_user";
        } else if (is_array($by_user)) {
            $where [] = "performed_by_guid in (" . implode(",", $by_user) . ")";
        }
    }
    if ($event != "") {
        $where[] = "event='$event'";
    }
    if ($class !== "") {
        $where[] = "object_class='$class'";
    }
    if ($type != "") {
        $where[] = "object_type='$type'";
    }
    if ($subtype !== "") {
        $where[] = "object_subtype='$subtype'";
    }

    if ($timebefore) {
        $where[] = "time_created < " . ((int) $timebefore);
    }
    if ($timeafter) {
        $where[] = "time_created > " . ((int) $timeafter);
    }
    if ($object_id) {
        $where[] = "object_id = " . ((int) $object_id);
    }
    if ($ip_address) {
        $where[] = "ip_address = '$ip_address'";
    }

    $select = "*";
    if ($count) {
        $select = "count(*) as count";
    }
    $query = "SELECT $select from {$CONFIG->dbprefix}system_log where 1 ";
    foreach ($where as $w) {
        $query .= " and $w";
    }

    if (!$count) {
        $query .= " order by time_created desc";
        $query .= " limit $offset, $limit"; // Add order and limit
    }

    if ($count) {
        $numrows = get_data_row($query);
        if ($numrows) {
            return $numrows->count;
        }
    } else {
        return get_data($query);
    }

    return false;
}

function get_log_entry($entry_id) {
    global $CONFIG;

    $entry_id = (int)$entry_id;

    return get_data_row("SELECT * from {$CONFIG->dbprefix}system_log where id=$entry_id");
}

function get_object_from_log_entry($entry) {
    if (is_numeric($entry)) {
        $entry = get_log_entry($entry);
        if (!$entry) {
            return false;
        }
    }

    $class = $entry->object_class;
    $id = $entry->object_id;

    if (!class_exists($class)) {
        // failed autoload
        return false;
    }

    $getters = array(
        'ElggAnnotation' => 'elgg_get_annotation_from_id',
        'ElggMetadata' => 'elgg_get_metadata_from_id',
        'ElggRelationship' => 'get_relationship',
    );

    if (isset($getters[$class]) && is_callable($getters[$class])) {
        $object = call_user_func($getters[$class], $id);
    } elseif (preg_match('~^Elgg[A-Z]~', $class)) {
        $object = get_entity($id);
    } else {
        // surround with try/catch because object could be disabled
        try {
            $object = new $class($entry->object_id);
            return $object;
        } catch (Exception $e) {
            
        }
    }

    if (!is_object($object) || get_class($object) !== $class) {
        return false;
    }

    return $object;
}

function system_log($object, $event) {
    global $CONFIG;
    static $log_cache;
    static $cache_size = 0;

    if ($object instanceof Loggable) {

        /* @var \ElggEntity|\ElggExtender $object */
        if (datalist_get('version') < 2012012000) {
            // this is a site that doesn't have the ip_address column yet
            return;
        }

        // reset cache if it has grown too large
        if (!is_array($log_cache) || $cache_size > 500) {
            $log_cache = array();
            $cache_size = 0;
        }

        // Has loggable interface, extract the necessary information and store
        $object_id = (int)$object->getSystemLogID();
        $object_class = get_class($object);
        $object_type = $object->getType();
        $object_subtype = $object->getSubtype();
        $event = sanitise_string($event);
        $time = time();
        $ip_address = sanitize_string(_elgg_services()->request->getClientIp());
        if (!$ip_address) {
            $ip_address = '0.0.0.0';
        }
        $performed_by = elgg_get_logged_in_user_guid();

        if (isset($object->access_id)) {
            $access_id = $object->access_id;
        } else {
            $access_id = ACCESS_PUBLIC;
        }
        if (isset($object->enabled)) {
            $enabled = $object->enabled;
        } else {
            $enabled = 'yes';
        }

        if (isset($object->owner_guid)) {
            $owner_guid = $object->owner_guid;
        } else {
            $owner_guid = 0;
        }

        // Create log if we haven't already created it
        if (!isset($log_cache[$time][$object_id][$event])) {
            $query = "INSERT into {$CONFIG->dbprefix}system_log
                (object_id, object_class, object_type, object_subtype, event,
                performed_by_guid, owner_guid, access_id, enabled, time_created, ip_address)
            VALUES
                ('$object_id','$object_class','$object_type', '$object_subtype', '$event',
                $performed_by, $owner_guid, $access_id, '$enabled', '$time', '$ip_address')";
            
            execute_delayed_write_query($query);

            $log_cache[$time][$object_id][$event] = true;
            $cache_size += 1;
        }
    }
}

function archive_log($offset = 0) {
    global $CONFIG;

    $offset = (int)$offset;
    $now = time(); // Take a snapshot of now

    $ts = $now - $offset;

    // create table
    $query = "CREATE TABLE {$CONFIG->dbprefix}system_log_$now as
        SELECT * from {$CONFIG->dbprefix}system_log WHERE time_created<$ts";

    if (!update_data($query)) {
        return false;
    }

    // delete
    // Don't delete on time since we are running in a concurrent environment
    if (delete_data("DELETE from {$CONFIG->dbprefix}system_log WHERE time_created<$ts") === false) {
        return false;
    }

    // alter table to engine
    if (!update_data("ALTER TABLE {$CONFIG->dbprefix}system_log_$now engine=archive")) {
        return false;
    }

    return true;
}

function system_log_default_logger($event, $object_type, $object) {
    system_log($object['object'], $object['event']);

    return true;
}

function system_log_listener($event, $object_type, $object) {
    if (($object_type != 'systemlog') && ($event != 'log')) {
        elgg_trigger_event('log', 'systemlog', array('object' => $object, 'event' => $event));
    }

    return true;
}

return function(\Elgg\EventsService $events, \Elgg\HooksRegistrationService $hooks) {
    $events->registerHandler('all', 'all', 'system_log_listener', 400);

    $events->registerHandler('log', 'systemlog', 'system_log_default_logger', 999);
};