diff options
Diffstat (limited to 'includes/Database/Options.php')
| -rw-r--r-- | includes/Database/Options.php | 249 |
1 files changed, 249 insertions, 0 deletions
diff --git a/includes/Database/Options.php b/includes/Database/Options.php new file mode 100644 index 0000000..0fcd9f0 --- /dev/null +++ b/includes/Database/Options.php @@ -0,0 +1,249 @@ +<?php + +/** + * YOURLS Options + * + * Note to plugin authors: you most likely SHOULD NOT use directly methods and properties of this class. Use instead + * function wrappers (eg don't use $ydb->option, or $ydb->get(), use yourls_*_options() functions instead). + * + * Note to devs: this class internally uses function wrappers eg yourls_*_options() instead of direct methods, to + * comply to any filter set in the function wrappers (eg $this->update() uses yourls_get_option()). + * Maybe in the future this will look as a dumb idea? + * The alternative would be to move return filters from function wrappers to here, but I think this will make things + * less readable for users. + * + * @since 1.7.3 + */ + +namespace YOURLS\Database; + +use YOURLS\Database\YDB; +use PDOException; + +class Options { + + /** + * Hold a copy of the all mighty $ydb global + * + * @var \YOURLS\Database\YDB + */ + protected $ydb; + + public function __construct(YDB $ydb) { + $this->ydb = $ydb; + } + + /** + * Read all options from DB at once, return bool + * + * @since 1.7.3 + * @return bool True on success, false on failure (eg table missing or empty) + */ + public function get_all_options() { + // Get option values from DB + $table = YOURLS_DB_TABLE_OPTIONS; + $sql = "SELECT option_name, option_value FROM $table WHERE 1=1"; + + try { + $options = (array) $this->ydb->fetchPairs($sql); + + } catch ( PDOException $e ) { + + // We could not fetch value from the table. Let's check if the option table exists + try { + $check = $this->ydb->fetchAffected(sprintf("SHOW TABLES LIKE '%s'", $table)); + // Table doesn't exist + if ($check ==0) { + return false; + } + + // Error at this point means the database isn't readable + } catch ( PDOException $e ) { + $this->ydb->dead_or_error($e); + } + + } + + + // Unlikely scenario, but who knows: table exists, but is empty + if (empty($options)) { + return false; + } + + foreach ($options as $name => $value) { + $this->ydb->set_option($name, yourls_maybe_unserialize($value)); + } + + yourls_apply_filter('get_all_options', 'deprecated'); + + return true; + } + + /** + * Get option value from DB (or from cache if available). Return value or $default if not found + * + * @since 1.7.3 + * @param string $name Option name + * @param string $default Optional value to return if option doesn't exist + * @return mixed Value set for the option + */ + public function get($name, $default) { + $name = trim((string)$name); + if (empty($name)) { + return $default; + } + + // Check if option value is cached already + if($this->ydb->has_option($name)) { + return $this->ydb->get_option($name); + } + + // Get option value from DB + $table = YOURLS_DB_TABLE_OPTIONS; + $sql = "SELECT option_value FROM $table WHERE option_name = :option_name LIMIT 1"; + $bind = array('option_name' => $name); + + // Use fechOne() to get array('option_value'=>$value), or false if not found. + // This way, we can effectively store false as an option value, and not confuse with false as the default return value + $value = $this->ydb->fetchOne($sql, $bind); + if($value !== false) { + $value = yourls_maybe_unserialize( $value['option_value'] ); + // Cache option value to save a DB query if needed later + $this->ydb->set_option($name, $value); + } else { + $value = $default; + } + + /** + * We don't cache value if option is not set, to make a difference between "not found: returning false" + * and "found, and value is false". + * This way, we can: + * $check = yourls_get_option('doesnt_exist'); // false + * yourls_add_option('doesnt_exist', 'value'); // will work, because check on has_option() will return false + */ + + return $value; + } + + /** + * Update (add if doesn't exist) an option to DB + * + * @since 1.7.3 + * @param string $name Option name. Expected to not be SQL-escaped. + * @param mixed $newvalue Option value. + * @return bool False if value was not updated, true otherwise. + */ + public function update($name, $newvalue) { + $name = trim((string)$name); + if (empty($name)) { + return false; + } + + // Use clone to break object refs -- see commit 09b989d375bac65e692277f61a84fede2fb04ae3 + if (is_object($newvalue)) { + $newvalue = clone $newvalue; + } + + $oldvalue = yourls_get_option($name); + + // If the new and old values are the same, no need to update. + if ($newvalue === $oldvalue) { + return false; + } + + // If this is a new option, just add it + if (false === $oldvalue) { + return $this->add($name, $newvalue); + } + + $_newvalue = yourls_maybe_serialize($newvalue); + $table = YOURLS_DB_TABLE_OPTIONS; + $sql = "UPDATE $table SET option_value = :value WHERE option_name = :name"; + $bind = array('name' => $name, 'value' => $_newvalue); + $do = $this->ydb->fetchAffected($sql, $bind); + + if($do !== 1) { + // Something went wrong :( + return false; + } + + // Cache option value to save a DB query if needed later + $this->ydb->set_option($name, $newvalue); + yourls_do_action( 'update_option', $name, $oldvalue, $newvalue ); + return true; + } + + /** + * Add an option to the DB + * + * @since 1.7.3 + * @param string $name Name of option to add. Expected to not be SQL-escaped. + * @param mixed $value Optional option value. Must be serializable if non-scalar. Expected to not be SQL-escaped. + * @return bool False if option was not added (eg already exists), true otherwise. + */ + public function add($name, $value) { + $name = trim((string)$name); + if (empty($name)) { + return false; + } + + // Use clone to break object refs -- see commit 09b989d375bac65e692277f61a84fede2fb04ae3 + if (is_object($value)) { + $value = clone $value; + } + + // Make sure the option doesn't already exist + if ($this->ydb->has_option($name)) { + return false; + } + // if (false !== yourls_get_option($name)) { + // return false; + // } + + $table = YOURLS_DB_TABLE_OPTIONS; + $_value = yourls_maybe_serialize($value); + $sql = "INSERT INTO $table (option_name, option_value) VALUES (:name, :value)"; + $bind = array('name' => $name, 'value' => $_value); + $do = $this->ydb->fetchAffected($sql, $bind); + + if($do !== 1) { + // Something went wrong :( + return false; + } + + // Cache option value to save a DB query if needed later + $this->ydb->set_option($name, $value); + yourls_do_action('add_option', $name, $_value); + + return true; + } + + /** + * Delete option from DB + * + * @since 1.7.3 + * @param string $name Option name to delete. Expected to not be SQL-escaped. + * @return bool False if option was not deleted (eg not found), true otherwise. + */ + public function delete($name) { + $name = trim((string)$name); + if (empty($name)) { + return false; + } + + $table = YOURLS_DB_TABLE_OPTIONS; + $sql = "DELETE FROM $table WHERE option_name = :name"; + $bind = array('name' => $name); + $do = $this->ydb->fetchAffected($sql, $bind); + + if($do !== 1) { + // Something went wrong :( + return false; + } + + yourls_do_action('delete_option', $name); + $this->ydb->delete_option($name); + return true; + } + +} |