1:   2:   3:   4:   5:   6:   7:   8:   9:  10:  11:  12:  13:  14:  15:  16:  17:  18:  19:  20:  21:  22:  23:  24:  25:  26:  27:  28:  29:  30:  31:  32:  33:  34:  35:  36:  37:  38:  39:  40:  41:  42:  43:  44:  45:  46:  47:  48:  49:  50:  51:  52:  53:  54:  55:  56:  57:  58:  59:  60:  61:  62:  63:  64:  65:  66:  67:  68:  69:  70:  71:  72:  73:  74:  75:  76:  77:  78:  79:  80:  81:  82:  83:  84:  85:  86:  87:  88:  89:  90:  91:  92:  93:  94:  95:  96:  97:  98:  99: 100: 101: 102: 103: 104: 105: 106: 107: 108: 109: 110: 111: 112: 113: 114: 115: 116: 117: 118: 119: 120: 121: 122: 123: 124: 125: 126: 127: 128: 129: 130: 131: 132: 133: 134: 135: 136: 137: 138: 139: 140: 141: 142: 143: 144: 145: 146: 147: 148: 149: 150: 151: 152: 153: 154: 155: 156: 157: 158: 159: 160: 161: 162: 163: 164: 165: 166: 167: 168: 169: 170: 171: 172: 173: 174: 175: 176: 177: 178: 179: 180: 181: 182: 183: 184: 185: 186: 187: 188: 189: 190: 191: 192: 193: 194: 195: 196: 197: 198: 199: 200: 201: 202: 203: 204: 205: 206: 207: 208: 209: 210: 211: 212: 213: 214: 215: 216: 217: 218: 219: 220: 221: 222: 223: 224: 225: 226: 227: 228: 229: 230: 231: 232: 233: 234: 235: 236: 237: 238: 239: 240: 241: 242: 243: 244: 245: 246: 247: 248: 249: 250: 251: 252: 253: 254: 255: 256: 257: 258: 

<?php

/**
 * This file contains a standard way of displaying lists for SMF.
 * Simple Machines Forum (SMF)
 *
 * @package SMF
 * @author Simple Machines https://www.simplemachines.org
 * @copyright 2020 Simple Machines and individual contributors
 * @license https://www.simplemachines.org/about/smf/license.php BSD
 *
 * @version 2.1 RC2
 */

if (!defined('SMF'))
    die('No direct access...');

/**
 * Create a new list
 *
 * @param array $listOptions An array of options for the list - 'id', 'columns', 'items_per_page', 'get_count', etc.
 */
function createList($listOptions)
{
    global $context, $smcFunc;

    assert(isset($listOptions['id']));
    assert(isset($listOptions['columns']));
    assert(is_array($listOptions['columns']));
    assert((empty($listOptions['items_per_page']) || (isset($listOptions['get_count']['function'], $listOptions['base_href']) && is_numeric($listOptions['items_per_page']))));
    assert((empty($listOptions['default_sort_col']) || isset($listOptions['columns'][$listOptions['default_sort_col']])));
    assert((!isset($listOptions['form']) || isset($listOptions['form']['href'])));

    call_integration_hook('integrate_' . $listOptions['id'], array(&$listOptions));

    // All the context data will be easily accessible by using a reference.
    $context[$listOptions['id']] = array();
    $list_context = &$context[$listOptions['id']];

    // Figure out the sort.
    if (empty($listOptions['default_sort_col']))
    {
        $list_context['sort'] = array();
        $sort = '1=1';
    }
    else
    {
        $request_var_sort = isset($listOptions['request_vars']['sort']) ? $listOptions['request_vars']['sort'] : 'sort';
        $request_var_desc = isset($listOptions['request_vars']['desc']) ? $listOptions['request_vars']['desc'] : 'desc';
        if (isset($_REQUEST[$request_var_sort], $listOptions['columns'][$_REQUEST[$request_var_sort]], $listOptions['columns'][$_REQUEST[$request_var_sort]]['sort']))
            $list_context['sort'] = array(
                'id' => $_REQUEST[$request_var_sort],
                'desc' => isset($_REQUEST[$request_var_desc]) && isset($listOptions['columns'][$_REQUEST[$request_var_sort]]['sort']['reverse']),
            );
        else
            $list_context['sort'] = array(
                'id' => $listOptions['default_sort_col'],
                'desc' => (!empty($listOptions['default_sort_dir']) && $listOptions['default_sort_dir'] == 'desc') || (!empty($listOptions['columns'][$listOptions['default_sort_col']]['sort']['default']) && substr($listOptions['columns'][$listOptions['default_sort_col']]['sort']['default'], -4, 4) == 'desc') ? true : false,
            );

        // Set the database column sort.
        $sort = $listOptions['columns'][$list_context['sort']['id']]['sort'][$list_context['sort']['desc'] ? 'reverse' : 'default'];
    }

    $list_context['start_var_name'] = isset($listOptions['start_var_name']) ? $listOptions['start_var_name'] : 'start';
    // In some cases the full list must be shown, regardless of the amount of items.
    if (empty($listOptions['items_per_page']))
    {
        $list_context['start'] = 0;
        $list_context['items_per_page'] = 0;
    }
    // With items per page set, calculate total number of items and page index.
    else
    {
        // First get an impression of how many items to expect.
        if (isset($listOptions['get_count']['file']))
            require_once($listOptions['get_count']['file']);

        $call = call_helper($listOptions['get_count']['function'], true);
        $list_context['total_num_items'] = call_user_func_array($call, empty($listOptions['get_count']['params']) ? array() : $listOptions['get_count']['params']);

        // Default the start to the beginning...sounds logical.
        $list_context['start'] = isset($_REQUEST[$list_context['start_var_name']]) ? (int) $_REQUEST[$list_context['start_var_name']] : 0;
        $list_context['items_per_page'] = $listOptions['items_per_page'];

        // Then create a page index.
        if ($list_context['total_num_items'] > $list_context['items_per_page'])
            $list_context['page_index'] = constructPageIndex($listOptions['base_href'] . (empty($list_context['sort']) ? '' : ';' . $request_var_sort . '=' . $list_context['sort']['id'] . ($list_context['sort']['desc'] ? ';' . $request_var_desc : '')) . ($list_context['start_var_name'] != 'start' ? ';' . $list_context['start_var_name'] . '=%1$d' : ''), $list_context['start'], $list_context['total_num_items'], $list_context['items_per_page'], $list_context['start_var_name'] != 'start');
    }

    // Prepare the headers of the table.
    $list_context['headers'] = array();
    foreach ($listOptions['columns'] as $column_id => $column)
        $list_context['headers'][] = array(
            'id' => $column_id,
            'label' => isset($column['header']['eval']) ? eval($column['header']['eval']) : (isset($column['header']['value']) ? $column['header']['value'] : ''),
            'href' => empty($listOptions['default_sort_col']) || empty($column['sort']) ? '' : $listOptions['base_href'] . ';' . $request_var_sort . '=' . $column_id . ($column_id === $list_context['sort']['id'] && !$list_context['sort']['desc'] && isset($column['sort']['reverse']) ? ';' . $request_var_desc : '') . (empty($list_context['start']) ? '' : ';' . $list_context['start_var_name'] . '=' . $list_context['start']),
            'sort_image' => empty($listOptions['default_sort_col']) || empty($column['sort']) || $column_id !== $list_context['sort']['id'] ? null : ($list_context['sort']['desc'] ? 'down' : 'up'),
            'class' => isset($column['header']['class']) ? $column['header']['class'] : '',
            'style' => isset($column['header']['style']) ? $column['header']['style'] : '',
            'colspan' => isset($column['header']['colspan']) ? $column['header']['colspan'] : '',
        );

    // We know the amount of columns, might be useful for the template.
    $list_context['num_columns'] = count($listOptions['columns']);
    $list_context['width'] = isset($listOptions['width']) ? $listOptions['width'] : '0';

    // Get the file with the function for the item list.
    if (isset($listOptions['get_items']['file']))
        require_once($listOptions['get_items']['file']);

    // Call the function and include which items we want and in what order.
    $call = call_helper($listOptions['get_items']['function'], true);
    $list_items = call_user_func_array($call, array_merge(array($list_context['start'], $list_context['items_per_page'], $sort), empty($listOptions['get_items']['params']) ? array() : $listOptions['get_items']['params']));
    $list_items = empty($list_items) ? array() : $list_items;

    // Loop through the list items to be shown and construct the data values.
    $list_context['rows'] = array();
    foreach ($list_items as $item_id => $list_item)
    {
        $cur_row = array();
        foreach ($listOptions['columns'] as $column_id => $column)
        {
            $cur_data = array();

            // A value straight from the database?
            if (isset($column['data']['db']))
                $cur_data['value'] = $list_item[$column['data']['db']];

            // Take the value from the database and make it HTML safe.
            elseif (isset($column['data']['db_htmlsafe']))
                $cur_data['value'] = $smcFunc['htmlspecialchars']($list_item[$column['data']['db_htmlsafe']]);

            // Using sprintf is probably the most readable way of injecting data.
            elseif (isset($column['data']['sprintf']))
            {
                $params = array();
                foreach ($column['data']['sprintf']['params'] as $sprintf_param => $htmlsafe)
                    $params[] = $htmlsafe ? $smcFunc['htmlspecialchars']($list_item[$sprintf_param]) : $list_item[$sprintf_param];
                $cur_data['value'] = vsprintf($column['data']['sprintf']['format'], $params);
            }

            // The most flexible way probably is applying a custom function.
            elseif (isset($column['data']['function']))
                $cur_data['value'] = call_user_func_array($column['data']['function'], array($list_item));

            // A modified value (inject the database values).
            elseif (isset($column['data']['eval']))
                $cur_data['value'] = eval(preg_replace('~%([a-zA-Z0-9\-_]+)%~', '$list_item[\'$1\']', $column['data']['eval']));

            // A literal value.
            elseif (isset($column['data']['value']))
                $cur_data['value'] = $column['data']['value'];

            // Empty value.
            else
                $cur_data['value'] = '';

            // Allow for basic formatting.
            if (!empty($column['data']['comma_format']))
                $cur_data['value'] = comma_format($cur_data['value']);
            elseif (!empty($column['data']['timeformat']))
                $cur_data['value'] = timeformat($cur_data['value']);

            // Set a style class for this column?
            if (isset($column['data']['class']))
                $cur_data['class'] = $column['data']['class'];

            // Fully customized styling for the cells in this column only.
            if (isset($column['data']['style']))
                $cur_data['style'] = $column['data']['style'];

            // Add the data cell properties to the current row.
            $cur_row[$column_id] = $cur_data;
        }

        // Maybe we wat set a custom class for the row based on the data in the row itself
        if (isset($listOptions['data_check']))
        {
            if (isset($listOptions['data_check']['class']))
                $list_context['rows'][$item_id]['class'] = $listOptions['data_check']['class']($list_item);
            if (isset($listOptions['data_check']['style']))
                $list_context['rows'][$item_id]['style'] = $listOptions['data_check']['style']($list_item);
        }

        // Insert the row into the list.
        $list_context['rows'][$item_id]['data'] = $cur_row;
    }

    // The title is currently optional.
    if (isset($listOptions['title']))
        $list_context['title'] = $listOptions['title'];

    // In case there's a form, share it with the template context.
    if (isset($listOptions['form']))
    {
        $list_context['form'] = $listOptions['form'];

        if (!isset($list_context['form']['hidden_fields']))
            $list_context['form']['hidden_fields'] = array();

        // Always add a session check field.
        $list_context['form']['hidden_fields'][$context['session_var']] = $context['session_id'];

        // Will this do a token check?
        if (isset($listOptions['form']['token']))
            $list_context['form']['hidden_fields'][$context[$listOptions['form']['token'] . '_token_var']] = $context[$listOptions['form']['token'] . '_token'];

        // Include the starting page as hidden field?
        if (!empty($list_context['form']['include_start']) && !empty($list_context['start']))
            $list_context['form']['hidden_fields'][$list_context['start_var_name']] = $list_context['start'];

        // If sorting needs to be the same after submitting, add the parameter.
        if (!empty($list_context['form']['include_sort']) && !empty($list_context['sort']))
        {
            $list_context['form']['hidden_fields']['sort'] = $list_context['sort']['id'];
            if ($list_context['sort']['desc'])
                $list_context['form']['hidden_fields']['desc'] = 1;
        }
    }

    // Wanna say something nice in case there are no items?
    if (isset($listOptions['no_items_label']))
    {
        $list_context['no_items_label'] = $listOptions['no_items_label'];
        $list_context['no_items_align'] = isset($listOptions['no_items_align']) ? $listOptions['no_items_align'] : '';
    }

    // A list can sometimes need a few extra rows above and below.
    if (isset($listOptions['additional_rows']))
    {
        $list_context['additional_rows'] = array();
        foreach ($listOptions['additional_rows'] as $row)
        {
            if (empty($row))
                continue;

            // Supported row positions: top_of_list, after_title,
            // above_column_headers, below_table_data, bottom_of_list.
            if (!isset($list_context['additional_rows'][$row['position']]))
                $list_context['additional_rows'][$row['position']] = array();
            $list_context['additional_rows'][$row['position']][] = $row;
        }
    }

    // Add an option for inline JavaScript.
    if (isset($listOptions['javascript']))
        $list_context['javascript'] = $listOptions['javascript'];

    // We want a menu.
    if (isset($listOptions['list_menu']))
        $list_context['list_menu'] = $listOptions['list_menu'];

    // Make sure the template is loaded.
    loadTemplate('GenericList');
}

?>