input.php

Go to the documentation of this file.

<?php
function get_input($variable, $default = null, $filter_result = true) {

    global $CONFIG;

    $result = $default;

    elgg_push_context('input');

    if (isset($CONFIG->input[$variable])) {
        // a plugin has already set this variable
        $result = $CONFIG->input[$variable];
        if ($filter_result) {
            $result = filter_tags($result);
        }
    } else {
        $request = _elgg_services()->request;
        $value = $request->get($variable);
        if ($value !== null) {
            $result = $value;
            if (is_string($result)) {
                // @todo why trim
                $result = trim($result);
            }

            if ($filter_result) {
                $result = filter_tags($result);
            }
        }
    }

    elgg_pop_context();

    return $result;
}

function set_input($variable, $value) {
    global $CONFIG;
    if (!isset($CONFIG->input)) {
        $CONFIG->input = array();
    }

    if (is_array($value)) {
        array_walk_recursive($value, create_function('&$v, $k', '$v = trim($v);'));
        $CONFIG->input[trim($variable)] = $value;
    } else {
        $CONFIG->input[trim($variable)] = trim($value);
    }
}

function filter_tags($var) {
    return elgg_trigger_plugin_hook('validate', 'input', null, $var);
}

function current_page_url() {
    $url = parse_url(elgg_get_site_url());

    $page = $url['scheme'] . "://" . $url['host'];

    if (isset($url['port']) && $url['port']) {
        $page .= ":" . $url['port'];
    }

    $page = trim($page, "/");

    $page .= _elgg_services()->request->getRequestUri();

    return $page;
}

function is_email_address($address) {
    return filter_var($address, FILTER_VALIDATE_EMAIL) === $address;
}

function elgg_make_sticky_form($form_name) {

    elgg_clear_sticky_form($form_name);

    $session = _elgg_services()->session;
    $data = $session->get('sticky_forms', array());
    $req = _elgg_services()->request;

    // will go through XSS filtering in elgg_get_sticky_value()
    $vars = array_merge($req->query->all(), $req->request->all());
    $data[$form_name] = $vars;

    $session->set('sticky_forms', $data);
}

function elgg_clear_sticky_form($form_name) {
    $session = _elgg_services()->session;
    $data = $session->get('sticky_forms', array());
    unset($data[$form_name]);
    $session->set('sticky_forms', $data);
}

function elgg_is_sticky_form($form_name) {
    $session = _elgg_services()->session;
    $data = $session->get('sticky_forms', array());
    return isset($data[$form_name]);
}

function elgg_get_sticky_value($form_name, $variable = '', $default = null, $filter_result = true) {
    $session = _elgg_services()->session;
    $data = $session->get('sticky_forms', array());
    if (isset($data[$form_name][$variable])) {
        $value = $data[$form_name][$variable];
        if ($filter_result) {
            // XSS filter result
            $value = filter_tags($value);
        }
        return $value;
    }
    return $default;
}

function elgg_get_sticky_values($form_name, $filter_result = true) {
    $session = _elgg_services()->session;
    $data = $session->get('sticky_forms', array());
    if (!isset($data[$form_name])) {
        return array();
    }

    $values = $data[$form_name];
    if ($filter_result) {
        foreach ($values as $key => $value) {
            // XSS filter result
            $values[$key] = filter_tags($value);
        }
    }
    return $values;
}

function elgg_clear_sticky_value($form_name, $variable) {
    $session = _elgg_services()->session;
    $data = $session->get('sticky_forms', array());
    unset($data[$form_name][$variable]);
    $session->set('sticky_forms', $data);
}

function input_livesearch_page_handler($page) {
    $dbprefix = elgg_get_config('dbprefix');

    // only return results to logged in users.
    if (!$user = elgg_get_logged_in_user_entity()) {
        exit;
    }

    if (!$q = get_input('term', get_input('q'))) {
        exit;
    }

    $input_name = get_input('name', 'members');

    $q = sanitise_string($q);

    // replace mysql vars with escaped strings
    $q = str_replace(array('_', '%'), array('\_', '\%'), $q);

    $match_on = get_input('match_on', 'all');

    if (!is_array($match_on)) {
        $match_on = array($match_on);
    }

    // all = users and groups
    if (in_array('all', $match_on)) {
        $match_on = array('users', 'groups');
    }

    $owner_guid = ELGG_ENTITIES_ANY_VALUE;
    if (get_input('match_owner', false)) {
        $owner_guid = $user->getGUID();
    }

    $limit = sanitise_int(get_input('limit', 10));

    // grab a list of entities and send them in json.
    $results = array();
    foreach ($match_on as $match_type) {
        switch ($match_type) {
            case 'users':
                $options = array(
                    'type' => 'user',
                    'limit' => $limit,
                    'joins' => array("JOIN {$dbprefix}users_entity ue ON e.guid = ue.guid"),
                    'wheres' => array(
                        "ue.banned = 'no'",
                        "(ue.name LIKE '$q%' OR ue.name LIKE '% $q%' OR ue.username LIKE '$q%')"
                    )
                );
                
                $entities = elgg_get_entities($options);
                if (!empty($entities)) {
                    foreach ($entities as $entity) {
                        
                        if (in_array('groups', $match_on)) {
                            $value = $entity->guid;
                        } else {
                            $value = $entity->username;
                        }

                        $output = elgg_view_list_item($entity, array(
                            'use_hover' => false,
                            'use_link' => false,
                            'class' => 'elgg-autocomplete-item',
                            'title' => $entity->name, // Default title would be a link
                        ));

                        $icon = elgg_view_entity_icon($entity, 'tiny', array(
                            'use_hover' => false,
                        ));

                        $result = array(
                            'type' => 'user',
                            'name' => $entity->name,
                            'desc' => $entity->username,
                            'guid' => $entity->guid,
                            'label' => $output,
                            'value' => $value,
                            'icon' => $icon,
                            'url' => $entity->getURL(),
                            'html' => elgg_view('input/userpicker/item', array(
                                'entity' => $entity,
                                'input_name' => $input_name,
                            )),
                        );
                        $results[$entity->name . rand(1, 100)] = $result;
                    }
                }
                break;

            case 'groups':
                // don't return results if groups aren't enabled.
                if (!elgg_is_active_plugin('groups')) {
                    continue;
                }
                
                $options = array(
                    'type' => 'group',
                    'limit' => $limit,
                    'owner_guid' => $owner_guid,
                    'joins' => array("JOIN {$dbprefix}groups_entity ge ON e.guid = ge.guid"),
                    'wheres' => array(
                        "(ge.name LIKE '$q%' OR ge.name LIKE '% $q%' OR ge.description LIKE '% $q%')"
                    )
                );
                
                $entities = elgg_get_entities($options);
                if (!empty($entities)) {
                    foreach ($entities as $entity) {
                        
                        $output = elgg_view_list_item($entity, array(
                            'use_hover' => false,
                            'class' => 'elgg-autocomplete-item',
                            'full_view' => false,
                            'href' => false,
                            'title' => $entity->name, // Default title would be a link
                        ));

                        $icon = elgg_view_entity_icon($entity, 'tiny', array(
                            'use_hover' => false,
                        ));

                        $result = array(
                            'type' => 'group',
                            'name' => $entity->name,
                            'desc' => strip_tags($entity->description),
                            'guid' => $entity->guid,
                            'label' => $output,
                            'value' => $entity->guid,
                            'icon' => $icon,
                            'url' => $entity->getURL(),
                        );

                        $results[$entity->name . rand(1, 100)] = $result;
                    }
                }
                break;

            case 'friends':
                $options = array(
                    'type' => 'user',
                    'limit' => $limit,
                    'relationship' => 'friend',
                    'relationship_guid' => $user->getGUID(),
                    'joins' => array("JOIN {$dbprefix}users_entity ue ON e.guid = ue.guid"),
                    'wheres' => array(
                        "ue.banned = 'no'",
                        "(ue.name LIKE '$q%' OR ue.name LIKE '% $q%' OR ue.username LIKE '$q%')"
                    )
                );
                
                $entities = elgg_get_entities_from_relationship($options);
                if (!empty($entities)) {
                    foreach ($entities as $entity) {
                        
                        $output = elgg_view_list_item($entity, array(
                            'use_hover' => false,
                            'use_link' => false,
                            'class' => 'elgg-autocomplete-item',
                            'title' => $entity->name, // Default title would be a link
                        ));

                        $icon = elgg_view_entity_icon($entity, 'tiny', array(
                            'use_hover' => false,
                        ));

                        $result = array(
                            'type' => 'user',
                            'name' => $entity->name,
                            'desc' => $entity->username,
                            'guid' => $entity->guid,
                            'label' => $output,
                            'value' => $entity->username,
                            'icon' => $icon,
                            'url' => $entity->getURL(),
                            'html' => elgg_view('input/userpicker/item', array(
                                'entity' => $entity,
                                'input_name' => $input_name,
                            )),
                        );
                        $results[$entity->name . rand(1, 100)] = $result;
                    }
                }
                break;

            default:
                header("HTTP/1.0 400 Bad Request", true);
                echo "livesearch: unknown match_on of $match_type";
                exit;
                break;
        }
    }

    ksort($results);
    header("Content-Type: application/json");
    echo json_encode(array_values($results));
    exit;
}

function _elgg_stripslashes_arraykeys($array) {
    if (is_array($array)) {
        $array2 = array();
        foreach ($array as $key => $data) {
            if ($key != stripslashes($key)) {
                $array2[stripslashes($key)] = $data;
            } else {
                $array2[$key] = $data;
            }
        }
        return $array2;
    } else {
        return $array;
    }
}

function _elgg_stripslashes_deep($value) {
    if (is_array($value)) {
        $value = _elgg_stripslashes_arraykeys($value);
        $value = array_map('_elgg_stripslashes_deep', $value);
    } else {
        $value = stripslashes($value);
    }
    return $value;
}

function _elgg_input_init() {
    // register an endpoint for live search / autocomplete.
    elgg_register_page_handler('livesearch', 'input_livesearch_page_handler');

    // backward compatible for plugins directly accessing globals
    if (get_magic_quotes_gpc()) {
        $_POST = array_map('_elgg_stripslashes_deep', $_POST);
        $_GET = array_map('_elgg_stripslashes_deep', $_GET);
        $_COOKIE = array_map('_elgg_stripslashes_deep', $_COOKIE);
        $_REQUEST = array_map('_elgg_stripslashes_deep', $_REQUEST);
        if (!empty($_SERVER['REQUEST_URI'])) {
            $_SERVER['REQUEST_URI'] = stripslashes($_SERVER['REQUEST_URI']);
        }
        if (!empty($_SERVER['QUERY_STRING'])) {
            $_SERVER['QUERY_STRING'] = stripslashes($_SERVER['QUERY_STRING']);
        }
        if (!empty($_SERVER['HTTP_REFERER'])) {
            $_SERVER['HTTP_REFERER'] = stripslashes($_SERVER['HTTP_REFERER']);
        }
        if (!empty($_SERVER['PATH_INFO'])) {
            $_SERVER['PATH_INFO'] = stripslashes($_SERVER['PATH_INFO']);
        }
        if (!empty($_SERVER['PHP_SELF'])) {
            $_SERVER['PHP_SELF'] = stripslashes($_SERVER['PHP_SELF']);
        }
        if (!empty($_SERVER['PATH_TRANSLATED'])) {
            $_SERVER['PATH_TRANSLATED'] = stripslashes($_SERVER['PATH_TRANSLATED']);
        }
    }
}

elgg_register_event_handler('init', 'system', '_elgg_input_init');