File trust_path/libraries/tuskfish/class/TfishPreference.php

  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 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364

<?php

/**
 * TfishPreference class file.
 * 
 * @copyright   Simon Wilkinson 2013-2017 (https://tuskfish.biz)
 * @license     https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html GNU General Public License (GPL) V2
 * @author      Simon Wilkinson <[email protected]>
 * @version     Release: 1.0
 * @since       1.0
 * @package     core
 */

// Enable strict type declaration.
declare(strict_types=1);

if (!defined("TFISH_ROOT_PATH")) die("TFISH_ERROR_ROOT_PATH_NOT_DEFINED");

/**
 * Holds Tuskfish site configuration data.
 * 
 * A preference object is automatically instantiated on every page via tfish_header.php.
 *
 * @copyright   Simon Wilkinson 2013-2017 (https://tuskfish.biz)
 * @license     https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html GNU General Public License (GPL) V2
 * @author      Simon Wilkinson <[email protected]>
 * @version     Release: 1.0
 * @since       1.0
 * @package     core
 * @property    string $site_name Name of website.
 * @property    string $site_description Meta description of website.
 * @property    string $site_author Author of website.
 * @property    string $site_email Administrative contact email for website.
 * @property    string $site_copyright Copyright notice.
 * @property    int $close_site Toggle to close this site.
 * @property    string $server_timezone Timezone of server location.
 * @property    string $site_timezone Timezone for main audience location.
 * @property    int $min_search_length Minimum length of search terms.
 * @property    int search_pagination Number of search results to show on a page.
 * @property    int user_pagination Number of content objects to show on public index page.
 * @property    int admin_pagination Number of content objects to show on admin index page.
 * @property    int gallery_pagination Number of images to show in admin gallery.
 * @property    int pagination_elements Number of slots to include on pagination controls.
 * @property    string session_name Name of session.
 * @property    int session_life Expiry timer for inactive sessions (minutes).
 * @property    string default_language Default language of site.
 * @property    string date_format Format to display dates, as per PHP date() function.
 * @property    int enable_cache Enable site cache.
 * @property    int cache_life Expiry timer for site cache (seconds).
 */
class TfishPreference extends TfishAncestralObject
{

    /** Initialise default properties. */
    function __construct()
    {
        /**
         * Set the permitted properties of this object.
         */
        $this->__properties['site_name'] = 'string';
        $this->__properties['site_description'] = 'string';
        $this->__properties['site_author'] = 'string';
        $this->__properties['site_email'] = 'email';
        $this->__properties['site_copyright'] = 'string';
        $this->__properties['close_site'] = 'int';
        $this->__properties['server_timezone'] = 'string';
        $this->__properties['site_timezone'] = 'string';
        $this->__properties['min_search_length'] = 'int';
        $this->__properties['search_pagination'] = 'int';
        $this->__properties['user_pagination'] = 'int';
        $this->__properties['admin_pagination'] = 'int';
        $this->__properties['gallery_pagination'] = 'int';
        $this->__properties['rss_posts'] = 'int';
        $this->__properties['pagination_elements'] = 'int';
        $this->__properties['session_name'] = 'alnum';
        $this->__properties['session_life'] = 'int';
        $this->__properties['default_language'] = 'alpha';
        $this->__properties['date_format'] = 'string';
        $this->__properties['enable_cache'] = 'int';
        $this->__properties['cache_life'] = 'int';

        // Instantiate whitelisted fields in the protected $__data property.
        foreach ($this->__properties as $key => $value) {
            $this->__data[$key] = '';
        }

        $preferences = self::readPreferences();
        
        foreach ($preferences as $key => $value) {
            if (isset($this->__data[$key])) {
                if ($this->__properties[$key] === 'int') {
                    $this->__set($key, (int) $value);
                } else {
                    $this->__set($key, $value);
                }
            }
            
            unset($key, $value);
        }
    }

    /**
     * Escape a property for on-screen display to prevent XSS.
     * 
     * Applies htmlspecialchars() to a property destined for display to mitigate XSS attacks.
     * Note that preference values should not be directly assigned to meta tags; they should be
     * assigned to $tfish_metadata instead, which will handle any escaping necessary.
     * 
     * @param string $property Name of property.
     * @return string Value of property escaped for display.
     */
    public function escape(string $property)
    {
        $clean_property = TfishFilter::trimString($property);
        
        if (isset($this->__data[$clean_property])) {
            switch ($clean_property) {
                default:
                    return htmlspecialchars($this->__data[$clean_property], ENT_NOQUOTES, 'UTF-8',
                            false);
                    break;
            }
        } else {
            return null;
        }
    }

    /**
     * Read out the site preferences into an array.
     * 
     * @return array Array of site preferences.
     */
    public static function readPreferences()
    {
        $preferences = array();
        $result = TfishDatabase::select('preference');
        
        while ($row = $result->fetch(PDO::FETCH_ASSOC)) {
            $preferences[$row['title']] = $row['value'];
        }
        
        return $preferences;
    }

    /**
     * Set the value of a whitelisted property.
     * 
     * Intercepts direct calls to set the value of object properties. Imposes data type
     * restrictions and range checks before allowing the properties to be set. 
     * 
     * @param string $property Name of property.
     * @param mixed $value Value of property.
     */
    public function __set(string $property, $value)
    {
        $clean_property = TfishFilter::trimString($property);
        
        // Check that property is whitelisted.
        if (!isset($this->__data[$clean_property])) {
            trigger_error(TFISH_ERROR_NO_SUCH_PROPERTY, E_USER_ERROR);
        }

        // Validate $value against expected data type and business rules.
        $type = $this->__properties[$clean_property];

        switch ($type) {
            case "alpha":
                $clean_value = TfishFilter::trimString($value);

                if ($clean_property === "language") {
                    $language_whitelist = TfishContentHandler::getLanguages();

                    if (!array_key_exists($clean_value, $language_whitelist)) {
                        trigger_error(TFISH_ERROR_ILLEGAL_VALUE, E_USER_ERROR);
                    }
                }

                if (TfishFilter::isAlpha($clean_value)) {
                    $this->__data[$clean_property] = $clean_value;
                } else {
                    trigger_error(TFISH_ERROR_NOT_ALPHA, E_USER_ERROR);
                }
                break;

            case "alnum":
                $clean_value = TfishFilter::trimString($value);

                if (TfishFilter::isAlnum($clean_value)) {
                    $this->__data[$clean_property] = $clean_value;
                } else {
                    trigger_error(TFISH_ERROR_NOT_ALNUM, E_USER_ERROR);
                }
                break;

            case "alnumunder":
                $clean_value = TfishFilter::trimString($value);

                if (TfishFilter::isAlnumUnderscore($clean_value)) {
                    $this->__data[$clean_property] = $clean_value;
                } else {
                    trigger_error(TFISH_ERROR_NOT_ALNUMUNDER, E_USER_ERROR);
                }
                break;

            case "bool":
                $clean_value = (bool) $value;
                
                if (TfishFilter::isBool($clean_value)) {
                    $this->__data[$clean_property] = (bool) $clean_value;
                } else {
                    trigger_error(TFISH_ERROR_NOT_BOOL, E_USER_ERROR);
                }
                break;

            case "email":
                $clean_value = TfishFilter::trimString($value);

                if (TfishFilter::isEmail($clean_value)) {
                    $this->__data[$clean_property] = $clean_value;
                } else {
                    trigger_error(TFISH_ERROR_NOT_EMAIL, E_USER_ERROR);
                }
                break;

            case "digit":
                $clean_value = TfishFilter::trimString($value);

                if (TfishFilter::isDigit($clean_value)) {
                    $this->__data[$clean_property] = $clean_value;
                } else {
                    trigger_error(TFISH_ERROR_NOT_DIGIT, E_USER_ERROR);
                }
                break;

            case "float":
                $clean_value = (float) $value;
                
                if (TfishFilter::isFloat($clean_value)) {
                    $this->__data[$clean_property] = $clean_value;
                } else {
                    trigger_error(TFISH_ERROR_NOT_FLOAT, E_USER_ERROR);
                }
                break;

            case "html":
                $clean_value = TfishFilter::trimString($value);
                $this->__data[$clean_property] = (string) TfishFilter::filterHtml($clean_value);
                break;

            case "int":
                $clean_value = (int) $value;
                
                switch ($clean_property) {
                    // 0 or 1.
                    case "close_site":
                    case "enable_cache":
                        if (TfishFilter::isInt($clean_value, 0, 1)) {
                            $this->__data[$clean_property] = $clean_value;
                        } else {
                            trigger_error(TFISH_ERROR_NOT_INT, E_USER_ERROR);
                        }
                        break;

                    // Minimum value 0.
                    case "search_pagination":
                    case "session_life":
                        if (TfishFilter::isInt($clean_value, 0)) {
                            $this->__data[$clean_property] = $clean_value;
                        } else {
                            trigger_error(TFISH_ERROR_NOT_INT, E_USER_ERROR);
                        }
                        break;

                    // Minimum value 1.
                    case "admin_pagination":
                    case "gallery_pagination":
                    case "user_pagination":
                    case "cache_life":
                    case "rss_posts":
                        if (TfishFilter::isInt($clean_value, 1)) {
                            $this->__data[$clean_property] = $clean_value;
                        } else {
                            trigger_error(TFISH_ERROR_NOT_INT, E_USER_ERROR);
                        }
                        break;

                    // Minimum value 3.
                    case "min_search_length":
                    case "pagination_elements":
                        if (TfishFilter::isInt($clean_value, 3)) {
                            $this->__data[$clean_property] = $clean_value;
                        } else {
                            trigger_error(TFISH_ERROR_NOT_INT, E_USER_ERROR);
                        }
                        break;
                }
                break;

            case "ip":
                $clean_value = TfishFilter::trimString($value);

                if ($clean_value === "" || TfishFilter::isIp($clean_value)) {
                    $this->__data[$clean_property] = $clean_value;
                } else {
                    trigger_error(TFISH_ERROR_NOT_IP, E_USER_ERROR);
                }
                break;

            case "string":
                $this->__data[$clean_property] = TfishFilter::trimString($value);
                break;

            case "url":
                $clean_value = TfishFilter::trimString($value);

                if ($clean_value === "" || TfishFilter::isUrl($clean_value)) {
                    $this->__data[$clean_property] = $clean_value;
                } else {
                    trigger_error(TFISH_ERROR_NOT_URL, E_USER_ERROR);
                }
                break;
        }
        
        return true;
    }

    /**
     * Update the preference object.
     * 
     * The preference object will conduct its own internal data type validation and range checks.
     * 
     * @param array $dirty_input Usually $_REQUEST data.
     */
    public function updatePreferences(array $dirty_input)
    {
        if (!TfishFilter::isArray($dirty_input)) {
            trigger_error(TFISH_ERROR_NOT_ARRAY, E_USER_ERROR);
        }

        // Obtain a whitelist of permitted fields.
        $whitelist = $this->getPropertyWhitelist();

        // Iterate through the whitelist validating supplied parameters.
        foreach ($whitelist as $key => $type) {
            if (array_key_exists($key, $dirty_input)) {
                $this->__set($key, $dirty_input[$key]);
            }
            
            unset($key, $type);
        }
    }

    /**
     * Save updated preferences to the database.
     * 
     * @return bool True on success false on failure.
     */
    private static function writePreferences()
    {
        return TfishDatabase::update('preference', $this->__data);
    }

}

Packages

Classes

Functions