aboutsummaryrefslogtreecommitdiff
path: root/srcs/phpmyadmin/libraries/classes/Bookmark.php
diff options
context:
space:
mode:
Diffstat (limited to 'srcs/phpmyadmin/libraries/classes/Bookmark.php')
-rw-r--r--srcs/phpmyadmin/libraries/classes/Bookmark.php395
1 files changed, 395 insertions, 0 deletions
diff --git a/srcs/phpmyadmin/libraries/classes/Bookmark.php b/srcs/phpmyadmin/libraries/classes/Bookmark.php
new file mode 100644
index 0000000..7dc1302
--- /dev/null
+++ b/srcs/phpmyadmin/libraries/classes/Bookmark.php
@@ -0,0 +1,395 @@
+<?php
+/* vim: set expandtab sw=4 ts=4 sts=4: */
+/**
+ * Handles bookmarking SQL queries
+ *
+ * @package PhpMyAdmin
+ */
+declare(strict_types=1);
+
+namespace PhpMyAdmin;
+
+use PhpMyAdmin\DatabaseInterface;
+use PhpMyAdmin\Relation;
+use PhpMyAdmin\Util;
+
+/**
+ * Handles bookmarking SQL queries
+ *
+ * @package PhpMyAdmin
+ */
+class Bookmark
+{
+ /**
+ * ID of the bookmark
+ *
+ * @var int
+ */
+ private $_id;
+ /**
+ * Database the bookmark belongs to
+ *
+ * @var string
+ */
+ private $_database;
+ /**
+ * The user to whom the bookmark belongs, empty for public bookmarks
+ *
+ * @var string
+ */
+ private $_user;
+ /**
+ * Label of the bookmark
+ *
+ * @var string
+ */
+ private $_label;
+ /**
+ * SQL query that is bookmarked
+ *
+ * @var string
+ */
+ private $_query;
+
+ /**
+ * @var DatabaseInterface
+ */
+ private $dbi;
+
+ /**
+ * Current user
+ *
+ * @var string
+ */
+ private $user;
+
+ /**
+ * Bookmark constructor.
+ *
+ * @param DatabaseInterface $dbi DatabaseInterface object
+ * @param string $user Current user
+ */
+ public function __construct(DatabaseInterface $dbi, string $user)
+ {
+ $this->dbi = $dbi;
+ $this->user = $user;
+ }
+
+ /**
+ * Returns the ID of the bookmark
+ *
+ * @return int
+ */
+ public function getId(): int
+ {
+ return (int) $this->_id;
+ }
+
+ /**
+ * Returns the database of the bookmark
+ *
+ * @return string
+ */
+ public function getDatabase(): string
+ {
+ return $this->_database;
+ }
+
+ /**
+ * Returns the user whom the bookmark belongs to
+ *
+ * @return string
+ */
+ public function getUser(): string
+ {
+ return $this->_user;
+ }
+
+ /**
+ * Returns the label of the bookmark
+ *
+ * @return string
+ */
+ public function getLabel(): string
+ {
+ return $this->_label;
+ }
+
+ /**
+ * Returns the query
+ *
+ * @return string
+ */
+ public function getQuery(): string
+ {
+ return $this->_query;
+ }
+
+ /**
+ * Adds a bookmark
+ *
+ * @return boolean whether the INSERT succeeds or not
+ *
+ * @access public
+ */
+ public function save(): bool
+ {
+ $cfgBookmark = self::getParams($this->user);
+ if (empty($cfgBookmark)) {
+ return false;
+ }
+
+ $query = "INSERT INTO " . Util::backquote($cfgBookmark['db'])
+ . "." . Util::backquote($cfgBookmark['table'])
+ . " (id, dbase, user, query, label) VALUES (NULL, "
+ . "'" . $this->dbi->escapeString($this->_database) . "', "
+ . "'" . $this->dbi->escapeString($this->_user) . "', "
+ . "'" . $this->dbi->escapeString($this->_query) . "', "
+ . "'" . $this->dbi->escapeString($this->_label) . "')";
+ return $this->dbi->query($query, DatabaseInterface::CONNECT_CONTROL);
+ }
+
+ /**
+ * Deletes a bookmark
+ *
+ * @return bool true if successful
+ *
+ * @access public
+ */
+ public function delete(): bool
+ {
+ $cfgBookmark = self::getParams($this->user);
+ if (empty($cfgBookmark)) {
+ return false;
+ }
+
+ $query = "DELETE FROM " . Util::backquote($cfgBookmark['db'])
+ . "." . Util::backquote($cfgBookmark['table'])
+ . " WHERE id = " . $this->_id;
+ return $this->dbi->tryQuery($query, DatabaseInterface::CONNECT_CONTROL);
+ }
+
+ /**
+ * Returns the number of variables in a bookmark
+ *
+ * @return int number of variables
+ */
+ public function getVariableCount(): int
+ {
+ $matches = [];
+ preg_match_all("/\[VARIABLE[0-9]*\]/", $this->_query, $matches, PREG_SET_ORDER);
+ return count($matches);
+ }
+
+ /**
+ * Replace the placeholders in the bookmark query with variables
+ *
+ * @param array $variables array of variables
+ *
+ * @return string query with variables applied
+ */
+ public function applyVariables(array $variables): string
+ {
+ // remove comments that encloses a variable placeholder
+ $query = preg_replace(
+ '|/\*(.*\[VARIABLE[0-9]*\].*)\*/|imsU',
+ '${1}',
+ $this->_query
+ );
+ // replace variable placeholders with values
+ $number_of_variables = $this->getVariableCount();
+ for ($i = 1; $i <= $number_of_variables; $i++) {
+ $var = '';
+ if (! empty($variables[$i])) {
+ $var = $this->dbi->escapeString($variables[$i]);
+ }
+ $query = str_replace('[VARIABLE' . $i . ']', $var, $query);
+ // backward compatibility
+ if ($i == 1) {
+ $query = str_replace('[VARIABLE]', $var, $query);
+ }
+ }
+ return $query;
+ }
+
+ /**
+ * Defines the bookmark parameters for the current user
+ *
+ * @param string $user Current user
+ *
+ * @return array|bool the bookmark parameters for the current user
+ * @access public
+ */
+ public static function getParams(string $user)
+ {
+ static $cfgBookmark = null;
+
+ if (null !== $cfgBookmark) {
+ return $cfgBookmark;
+ }
+
+ $relation = new Relation($GLOBALS['dbi']);
+ $cfgRelation = $relation->getRelationsParam();
+ if ($cfgRelation['bookmarkwork']) {
+ $cfgBookmark = [
+ 'user' => $user,
+ 'db' => $cfgRelation['db'],
+ 'table' => $cfgRelation['bookmark'],
+ ];
+ } else {
+ $cfgBookmark = false;
+ }
+
+ return $cfgBookmark;
+ }
+
+ /**
+ * Creates a Bookmark object from the parameters
+ *
+ * @param DatabaseInterface $dbi DatabaseInterface object
+ * @param string $user Current user
+ * @param array $bkm_fields the properties of the bookmark to add; here,
+ * $bkm_fields['bkm_sql_query'] is urlencoded
+ * @param boolean $all_users whether to make the bookmark
+ * available for all users
+ *
+ * @return Bookmark|false
+ */
+ public static function createBookmark(
+ DatabaseInterface $dbi,
+ string $user,
+ array $bkm_fields,
+ bool $all_users = false
+ ) {
+ if (! (isset($bkm_fields['bkm_sql_query'])
+ && strlen($bkm_fields['bkm_sql_query']) > 0
+ && isset($bkm_fields['bkm_label'])
+ && strlen($bkm_fields['bkm_label']) > 0)
+ ) {
+ return false;
+ }
+
+ $bookmark = new Bookmark($dbi, $user);
+ $bookmark->_database = $bkm_fields['bkm_database'];
+ $bookmark->_label = $bkm_fields['bkm_label'];
+ $bookmark->_query = $bkm_fields['bkm_sql_query'];
+ $bookmark->_user = $all_users ? '' : $bkm_fields['bkm_user'];
+
+ return $bookmark;
+ }
+
+ /**
+ * Gets the list of bookmarks defined for the current database
+ *
+ * @param DatabaseInterface $dbi DatabaseInterface object
+ * @param string $user Current user
+ * @param string|bool $db the current database name or false
+ *
+ * @return Bookmark[] the bookmarks list
+ *
+ * @access public
+ */
+ public static function getList(
+ DatabaseInterface $dbi,
+ string $user,
+ $db = false
+ ): array {
+ $cfgBookmark = self::getParams($user);
+ if (empty($cfgBookmark)) {
+ return [];
+ }
+
+ $query = "SELECT * FROM " . Util::backquote($cfgBookmark['db'])
+ . "." . Util::backquote($cfgBookmark['table'])
+ . " WHERE ( `user` = ''"
+ . " OR `user` = '" . $dbi->escapeString($cfgBookmark['user']) . "' )";
+ if ($db !== false) {
+ $query .= " AND dbase = '" . $dbi->escapeString($db) . "'";
+ }
+ $query .= " ORDER BY label ASC";
+
+ $result = $dbi->fetchResult(
+ $query,
+ null,
+ null,
+ DatabaseInterface::CONNECT_CONTROL,
+ DatabaseInterface::QUERY_STORE
+ );
+
+ if (! empty($result)) {
+ $bookmarks = [];
+ foreach ($result as $row) {
+ $bookmark = new Bookmark($dbi, $user);
+ $bookmark->_id = $row['id'];
+ $bookmark->_database = $row['dbase'];
+ $bookmark->_user = $row['user'];
+ $bookmark->_label = $row['label'];
+ $bookmark->_query = $row['query'];
+ $bookmarks[] = $bookmark;
+ }
+
+ return $bookmarks;
+ }
+
+ return [];
+ }
+
+ /**
+ * Retrieve a specific bookmark
+ *
+ * @param DatabaseInterface $dbi DatabaseInterface object
+ * @param string $user Current user
+ * @param string $db the current database name
+ * @param mixed $id an identifier of the bookmark to get
+ * @param string $id_field which field to look up the identifier
+ * @param boolean $action_bookmark_all true: get all bookmarks regardless
+ * of the owning user
+ * @param boolean $exact_user_match whether to ignore bookmarks with no user
+ *
+ * @return Bookmark the bookmark
+ *
+ * @access public
+ *
+ */
+ public static function get(
+ DatabaseInterface $dbi,
+ string $user,
+ string $db,
+ $id,
+ string $id_field = 'id',
+ bool $action_bookmark_all = false,
+ bool $exact_user_match = false
+ ): ?self {
+ $cfgBookmark = self::getParams($user);
+ if (empty($cfgBookmark)) {
+ return null;
+ }
+
+ $query = "SELECT * FROM " . Util::backquote($cfgBookmark['db'])
+ . "." . Util::backquote($cfgBookmark['table'])
+ . " WHERE dbase = '" . $dbi->escapeString($db) . "'";
+ if (! $action_bookmark_all) {
+ $query .= " AND (user = '"
+ . $dbi->escapeString($cfgBookmark['user']) . "'";
+ if (! $exact_user_match) {
+ $query .= " OR user = ''";
+ }
+ $query .= ")";
+ }
+ $query .= " AND " . Util::backquote($id_field)
+ . " = '" . $dbi->escapeString((string) $id) . "' LIMIT 1";
+
+ $result = $dbi->fetchSingleRow($query, 'ASSOC', DatabaseInterface::CONNECT_CONTROL);
+ if (! empty($result)) {
+ $bookmark = new Bookmark($dbi, $user);
+ $bookmark->_id = $result['id'];
+ $bookmark->_database = $result['dbase'];
+ $bookmark->_user = $result['user'];
+ $bookmark->_label = $result['label'];
+ $bookmark->_query = $result['query'];
+ return $bookmark;
+ }
+
+ return null;
+ }
+}
generated by cgit (git 2.34.1) at 2026-05-16 04:53:18 +0000