filter_project_list.inc

<?php
include_once($relPath.'misc.inc'); // attr_safe()
include_once($relPath.'iso_lang_list.inc');

// This file includes functions to handle the creation, update, and display of
// the project filters used on the Round, Project, and Smooth Reading pages.
// This includes displaying the form, processing updates made from the form,
// and getting the filter values from the user_filters table.
//
// For consistency the form field names (also $field and $fields in the
// functions) use the corresponding column name from the projects table. Hence
// the field name for the Post Processor is checkedoutby and the field for
// Project Managers is username.

class ProjectFilterElement
{
    function __construct($id, $label, $data, $state_sql, $active_fields)
    {
        $this->id = $id;
        $this->label = $label;
        $this->active = $active_fields[$id];
        $this->data = $data;
        $this->state_sql = $state_sql;
        $this->selected_options = [];
    }

    function echo_html_control()
    {
        if(!$this->active)
        {
            return;
        }
        $this->echo_active_html_control();
    }

    // Difficulty overrides this
    protected function echo_active_html_control()
    {
        echo "<td>";
        echo "<b>$this->label:</b><br>";
        $this->echo_selector();
        echo "</td>\n";
    }

    protected function echo_selector()
    {
        echo "<select name='{$this->id}[]' id=$this->id size='4' multiple>";
        $options = $this->get_options();
        $selected_keys = array_get($this->data, $this->id, []);
        echo_option("", _('Any'), empty($selected_keys));
        foreach($options as $key => $value)
        {
            $selected = in_array($key, $selected_keys);
            if($selected)
            {
                // make array of values to use in display
                $this->selected_options[] = $value;
            }
            echo_option($key, $value, $selected);
        }
        echo "</select>";
    }

    // project manager and post processor use this function, others override it
    protected function get_options()
    {
        $query = "SELECT distinct $this->id FROM projects WHERE ($this->state_sql) ORDER BY $this->id";
        $options = [];
        $result = mysqli_query(DPDatabase::get_connection(), $query) or die(mysqli_error(DPDatabase::get_connection()));
        while ($cols = mysqli_fetch_row($result))
        {
            $options[$cols[0]] = $cols[0];
        }
        return $options;
    }
}

function echo_option($key, $value, $selected)
{
    $selected_attr = $selected ? ' selected' : '';
    echo "<option value='" . attr_safe($key) . "'$selected_attr>$value</option>\n";
}

class GenreElement extends ProjectFilterElement
{
    protected function get_options()
    {
        maybe_create_temporary_genre_translation_table();
        $query = "
            SELECT distinct projects.genre, genre_translations.trans_genre
            FROM projects NATURAL JOIN genre_translations
            WHERE ($this->state_sql) ORDER BY trans_genre";
        $options = [];
        $result = mysqli_query(DPDatabase::get_connection(), $query) or die(mysqli_error(DPDatabase::get_connection()));
        while ($cols = mysqli_fetch_row($result))
        {
            $options[$cols[0]] = $cols[1];
        }
        return $options;
    }
}

class SpecialDayElement extends ProjectFilterElement
{
    protected function get_options()
    {
        $query = "
            SELECT  DISTINCT special_code, display_name
            FROM projects, special_days
            WHERE projects.special_code = special_days.spec_code AND ($this->state_sql) ORDER BY display_name";
        $options = [];
        $result = mysqli_query(DPDatabase::get_connection(), $query) or die(mysqli_error(DPDatabase::get_connection()));
        while ($cols = mysqli_fetch_row($result))
        {
            $options[$cols[0]] = $cols[1];
        }
        return $options;
    }
}

class LanguageElement extends ProjectFilterElement
{
    protected function get_options()
    {
        global $lang_list;

        $options = [];
        foreach($lang_list as $name_code)
        {
            $lang = $name_code["lang_name"];
            $options[$lang] = $lang;
        }
        return $options;
    }

    protected function echo_active_html_control()
    {
        echo "<td>";
        echo "<b>$this->label:</b><br>";
        $this->echo_selector();
        echo "<br>";

        $selected_key = get_lang_match($this->data);
        $lang_options = [
            'primary' => _("Primary only"),
            'primwith' => _("Primary with any"),
            'anywhere' => _("Primary or Secondary"),
            ];
        echo "<select name='lang-match' id='lang-match'>";
        foreach($lang_options as $key => $value)
        {
            echo_option($key, $value, $key == $selected_key);
        }
        echo "</select>";
        echo "</td>\n";
    }
}

class DifficultyElement extends ProjectFilterElement
{
    function echo_active_html_control()
    {
        echo "<p><b>$this->label:</b> ";
        echo "<label for='diff-all'>" . pgettext("all difficulties", "All") . "</label><input type='checkbox' name='difficulty[]' id='diff-all' value=''";
        $difficulty = array_get($this->data, "difficulty", []);
        if(!count($difficulty))
            echo " checked";
        echo ">\n";
        $difficulty_options= array('beginner' => _("Beginners Only"), 'easy' => _("Easy"), 'average' => _("Average"), 'hard' => _("Hard"));
        foreach($difficulty_options as $value => $option)
        {
            echo "<label for='$value'>&nbsp;$option</label><input type='checkbox' name='difficulty[]' class='diff-opt' id='$value' value='$value'";
            if(is_array($difficulty) && in_array($value, $difficulty))
            {
                echo " checked";
                $this->selected_options[] = $option;
            }
            echo ">\n";
        }
        echo "</p>\n";
    }
}

function process_and_display_project_filter_form($username, $filter_type, $filter_label, $data, $state_sql, $custom_display_fields = NULL)
{
    $display_fields = [
        "language" => TRUE,
        "genre" => TRUE,
        "username" => TRUE,
        "difficulty" => TRUE,
        "special_code" => TRUE,
        "checkedoutby" => FALSE,
    ];
    // overwrite the default display state of the form fields with any
    // custom display requests
    if($custom_display_fields && is_array($custom_display_fields))
    {
        $display_fields = array_merge($display_fields, $custom_display_fields);
    }
    // if there is data save it, else get saved data
    // if they want to reset the filter, zero out the data passed in
    if(array_key_exists("reset", $data))
    {
        $data = [];
        save_data($username, $filter_type, $data);
    }
    else if(array_key_exists("apply", $data))
    {
        unset($data["apply"]);
        // remove the 'any' options, save space,
        // for making sql we would have to exclude them if they were present
        // for controls we have to interpret nothing as any
        $new_data = [];
        foreach($data as $category => $values)
        {
            if (is_array($values) && (($key = array_search('', $values)) !== false))
            {
                unset($values[$key]);
            }
            $new_data[$category] = $values;
        }
        $data = $new_data;
        save_data($username, $filter_type, $data);
    }
    else
    {
        $data = get_saved_data($username, $filter_type);
    }

    $genre_element = new GenreElement("genre", _("Genre"), $data, $state_sql, $display_fields);
    $pm_element = new ProjectFilterElement("username", _("Project Manager"), $data, $state_sql, $display_fields);
    $pp_element = new ProjectFilterElement("checkedoutby", _("Post Processor"), $data, $state_sql, $display_fields);
    $special_day_element = new SpecialDayElement("special_code", _("Special Days"), $data, $state_sql, $display_fields);
    $difficulty_element = new DifficultyElement("difficulty", _("Difficulty"), $data, $state_sql, $display_fields);
    $pri_lang_element = new LanguageElement("language", _("Language"), $data, $state_sql, $display_fields);
    $elements = [
        $genre_element,
        $pm_element,
        $pp_element,
        $special_day_element,
        $pri_lang_element,
        $difficulty_element,
    ];

    echo "\n<form id='filter_form' method='post' action='#filter_form'>\n";
    echo "<fieldset><legend>" . sprintf(_("Filter available %s books by:"), $filter_label) . "</legend>\n";
    echo "<table class='filter'>\n";

    // create the row for listboxes for Language, Genre, PM, Special Days, PPers (when enabled)
    echo "<tr>\n";

    $elements_on_first_line = [$genre_element, $pm_element, $pp_element, $special_day_element, $pri_lang_element];

    foreach($elements_on_first_line as $element)
    {
        $element->echo_html_control();
    }
    echo "</tr>\n";
    echo "</table>\n";

    $difficulty_element->echo_html_control();

    echo "<input type='submit' name='reset' value='", attr_safe(_("Remove Filter")), "'>";
    echo "&nbsp;<input type='submit' name='apply' value='", attr_safe(_("Apply Selections")), "'>";
    echo "</fieldset>";
    echo "</form>\n";

    // construct the summary display
    $display_lines = [];
    foreach($elements as $element)
    {
        if($element->selected_options)
        {
            $display_lines[] = $element->label . " = " . implode("; ", $element->selected_options);
        }
    }
    // save a single line version to use in activity hub
    save_display($username, $filter_type, implode(" | ",$display_lines));

    echo "<p>", _("Current filter:"), " <b>";

    // show multi-line version on this page
    if(!empty($display_lines))
    {
        foreach($display_lines as $line)
        {
            echo "<br>$line";
        }
    }
    else
    {
        echo _("No filter, all books shown.");
    }
    echo "</b></p>\n";
}

// ----- classes & functions for getting sql and display data

class ProjectSearchElement
{
    function __construct($id, $data)
    {
        $this->id = $id;
        $this->data = $data;
    }

    function get_sql_component()
    {
        $values = array_get($this->data, $this->id, []);
        if(empty($values))
        {
            return "";
        }
        array_walk($values, function(&$value) {
            $value = mysqli_real_escape_string(DPDatabase::get_connection(), $value);
        });
        return $this->construct_sql($values);
    }

    function construct_sql($values)
    {
        $values_list = surround_and_join( $values, "'", "'", ", " );
        return " AND $this->id IN ($values_list)";
    }
}

class LanguageSearchElement extends ProjectSearchElement
{
    function construct_sql($values)
    {
        // some languages have regex special chars which need escaping
        array_walk($values, function(&$value) {
            $value = sql_regex_escape($value);
        });
        $langstring = implode("|", $values);
        // for primary language match strings starting with it
        // for primary only match end also
        // need to check "with" to avoid matching "French, Old" etc.
        switch(get_lang_match($this->data)) {
        case "primary":
            $prefix = "^";
            $suffix = "$";
            break;
        case "primwith":
            $prefix = "^";
            $suffix = "($| with.*)";
            break;
        case "anywhere":
        default:
            $prefix = ".*";
            $suffix = "($| with.*)";
            break;
        }
        return " AND language REGEXP '$prefix($langstring)$suffix'";
    }
}

function get_project_filter_sql($pguser, $filter_type)
{
    $data = get_saved_data($pguser, $filter_type);
    $search_elements = [
        new ProjectSearchElement("genre", $data),
        new ProjectSearchElement("username", $data),
        new ProjectSearchElement("checkedoutby", $data),
        new ProjectSearchElement("special_code", $data),
        new ProjectSearchElement("difficulty", $data),
        new LanguageSearchElement("language", $data),
    ];

    $filter = "";
    foreach($search_elements as $element)
    {
        $filter .= $element->get_sql_component();
    }
    return $filter;
}

function sql_regex_escape($value)
{
    // double the backslashes introduced by quotemeta
    return str_replace('\\', '\\\\', quotemeta($value));
}

function get_lang_match($data)
{
    // set a default if not set
    return array_get($data, "lang-match", "primwith");
}

function save_data($pguser, $filter_type, $data)
{
    save_raw_data($pguser, "{$filter_type}_data", serialize($data));
}

function save_display($pguser, $filter_type, $data)
{
    save_raw_data($pguser, "{$filter_type}_display", $data);
}

function save_raw_data($pguser, $data_name, $data)
{
    $enc_data = mysqli_real_escape_string(DPDatabase::get_connection(), $data);
    $query = "REPLACE INTO user_filters (username, filtertype, value) VALUES ('$pguser', '$data_name', '$enc_data')";
    mysqli_query(DPDatabase::get_connection(), $query) or die(mysqli_error(DPDatabase::get_connection()));
}

function get_saved_data($pguser, $filter_type)
{
    return unserialize(get_raw_saved_data($pguser, "${filter_type}_data"));
}

function get_project_filter_display($pguser, $filter_type)
{
    return get_raw_saved_data($pguser, "${filter_type}_display");
}

function get_raw_saved_data($pguser, $data_name)
{
    $data_name = mysqli_real_escape_string(DPDatabase::get_connection(), $data_name);
    $query = "SELECT value FROM user_filters WHERE username = '$pguser' AND filtertype = '$data_name'";
    $result = mysqli_query(DPDatabase::get_connection(), $query) or die(mysqli_error(DPDatabase::get_connection()));
    $row = mysqli_fetch_assoc($result);
    if($row)
    {
        return $row["value"];
    }
    else
    {
        return "";
    }
}

// vim: sw=4 ts=4 expandtab