libraries/bookmark.lib.php

   1 <?php
   2 /* vim: set expandtab sw=4 ts=4 sts=4: */
   3 /**
   4  * Set of functions used with the bookmark feature
   5  *
   6  * @package PhpMyAdmin
   7  */
   8
   9 if (! defined('PHPMYADMIN')) {
  10     exit;
  11 }
  12
  13 /**
  14  * Defines the bookmark parameters for the current user
  15  *
  16  * @return array    the bookmark parameters for the current user
  17  * @access  public
  18  */
  19 function PMA_Bookmark_getParams()
  20 {
  21     static $cfgBookmark = null;
  22
  23     if (null !== $cfgBookmark) {
  24         return $cfgBookmark;
  25     }
  26
  27     $cfgRelation = PMA_getRelationsParam();
  28
  29     if ($cfgRelation['bookmarkwork']) {
  30         $cfgBookmark = array(
  31             'user'  => $GLOBALS['cfg']['Server']['user'],
  32             'db'    => $GLOBALS['cfg']['Server']['pmadb'],
  33             'table' => $GLOBALS['cfg']['Server']['bookmarktable'],
  34         );
  35     } else {
  36         $cfgBookmark = false;
  37     }
  38
  39     return $cfgBookmark;
  40 } // end of the 'PMA_Bookmark_getParams()' function
  41
  42
  43 /**
  44  * Gets the list of bookmarks defined for the current database
  45  *
  46  * @param string $db the current database name
  47  *
  48  * @return array the bookmarks list (key as index, label as value)
  49  *
  50  * @access public
  51  *
  52  * @global resource the controluser db connection handle
  53  */
  54 function PMA_Bookmark_getList($db)
  55 {
  56     global $controllink;
  57
  58     $cfgBookmark = PMA_Bookmark_getParams();
  59
  60     if (empty($cfgBookmark)) {
  61         return array();
  62     }
  63
  64     $query  = 'SELECT label, id FROM '. PMA_Util::backquote($cfgBookmark['db'])
  65         . '.' . PMA_Util::backquote($cfgBookmark['table'])
  66         . ' WHERE dbase = \'' . PMA_Util::sqlAddSlashes($db) . '\''
  67         . ' AND user = \'' . PMA_Util::sqlAddSlashes($cfgBookmark['user']) . '\''
  68         . ' ORDER BY label';
  69     $per_user = $GLOBALS['dbi']->fetchResult(
  70         $query, 'id', 'label', $controllink, PMA_DatabaseInterface::QUERY_STORE
  71     );
  72
  73     $query  = 'SELECT label, id FROM '. PMA_Util::backquote($cfgBookmark['db'])
  74         . '.' . PMA_Util::backquote($cfgBookmark['table'])
  75         . ' WHERE dbase = \'' . PMA_Util::sqlAddSlashes($db) . '\''
  76         . ' AND user = \'\''
  77         . ' ORDER BY label';
  78     $global = $GLOBALS['dbi']->fetchResult(
  79         $query, 'id', 'label', $controllink, PMA_DatabaseInterface::QUERY_STORE
  80     );
  81
  82     foreach ($global as $key => $val) {
  83         $global[$key] = $val . ' (' . __('shared') . ')';
  84     }
  85
  86     $ret = $global + $per_user;
  87
  88     asort($ret);
  89
  90     return $ret;
  91 } // end of the 'PMA_Bookmark_getList()' function
  92
  93
  94 /**
  95  * Gets the sql command from a bookmark
  96  *
  97  * @param string  $db                  the current database name
  98  * @param mixed   $id                  the id of the bookmark to get
  99  * @param string  $id_field            which field to look up the $id
 100  * @param boolean $action_bookmark_all true: get all bookmarks regardless
 101  *                                     of the owning user
 102  * @param boolean $exact_user_match    whether to ignore bookmarks with no user
 103  *
 104  * @return string    the sql query
 105  *
 106  * @access  public
 107  *
 108  * @global  resource  the controluser db connection handle
 109  *
 110  */
 111 function PMA_Bookmark_get($db, $id, $id_field = 'id', $action_bookmark_all = false,
 112     $exact_user_match = false
 113 ) {
 114     global $controllink;
 115
 116     $cfgBookmark = PMA_Bookmark_getParams();
 117
 118     if (empty($cfgBookmark)) {
 119         return '';
 120     }
 121
 122     $query = 'SELECT query FROM ' . PMA_Util::backquote($cfgBookmark['db'])
 123         . '.' . PMA_Util::backquote($cfgBookmark['table'])
 124         . ' WHERE dbase = \'' . PMA_Util::sqlAddSlashes($db) . '\'';
 125
 126     if (! $action_bookmark_all) {
 127         $query .= ' AND (user = \''
 128             . PMA_Util::sqlAddSlashes($cfgBookmark['user']) . '\'';
 129         if (! $exact_user_match) {
 130             $query .= ' OR user = \'\'';
 131         }
 132         $query .= ')';
 133     }
 134
 135     $query .= ' AND ' . PMA_Util::backquote($id_field) . ' = ' . $id;
 136
 137     return $GLOBALS['dbi']->fetchValue($query, 0, 0, $controllink);
 138 } // end of the 'PMA_Bookmark_get()' function
 139
 140 /**
 141  * Adds a bookmark
 142  *
 143  * @param array   $bkm_fields the properties of the bookmark to add; here,
 144  *                            $bkm_fields['bkm_sql_query'] is urlencoded
 145  * @param boolean $all_users  whether to make the bookmark available for all users
 146  *
 147  * @return boolean   whether the INSERT succeeds or not
 148  *
 149  * @access  public
 150  *
 151  * @global  resource  the controluser db connection handle
 152  */
 153 function PMA_Bookmark_save($bkm_fields, $all_users = false)
 154 {
 155     global $controllink;
 156
 157     $cfgBookmark = PMA_Bookmark_getParams();
 158
 159     if (empty($cfgBookmark)) {
 160         return false;
 161     }
 162
 163     $query = 'INSERT INTO ' . PMA_Util::backquote($cfgBookmark['db'])
 164         . '.' . PMA_Util::backquote($cfgBookmark['table'])
 165         . ' (id, dbase, user, query, label)'
 166         . ' VALUES (NULL, \''
 167         . PMA_Util::sqlAddSlashes($bkm_fields['bkm_database']) . '\', '
 168         . '\''
 169         . ($all_users ? '' : PMA_Util::sqlAddSlashes($bkm_fields['bkm_user']))
 170         . '\', '
 171         . '\''
 172         . PMA_Util::sqlAddSlashes(urldecode($bkm_fields['bkm_sql_query']))
 173         . '\', '
 174         . '\'' . PMA_Util::sqlAddSlashes($bkm_fields['bkm_label']) . '\')';
 175     return $GLOBALS['dbi']->query($query, $controllink);
 176 } // end of the 'PMA_Bookmark_save()' function
 177
 178
 179 /**
 180  * Deletes a bookmark
 181  *
 182  * @param string  $db the current database name
 183  * @param integer $id the id of the bookmark to get
 184  *
 185  * @return bool true if successful
 186  *
 187  * @access  public
 188  *
 189  * @global  resource  the controluser db connection handle
 190  */
 191 function PMA_Bookmark_delete($db, $id)
 192 {
 193     global $controllink;
 194
 195     $cfgBookmark = PMA_Bookmark_getParams();
 196
 197     if (empty($cfgBookmark)) {
 198         return false;
 199     }
 200
 201     $query  = 'DELETE FROM ' . PMA_Util::backquote($cfgBookmark['db'])
 202         . '.' . PMA_Util::backquote($cfgBookmark['table'])
 203         . ' WHERE (user = \'' . PMA_Util::sqlAddSlashes($cfgBookmark['user']) . '\''
 204         . '        OR user = \'\')'
 205         . ' AND id = ' . $id;
 206     return $GLOBALS['dbi']->tryQuery($query, $controllink);
 207 } // end of the 'PMA_Bookmark_delete()' function
 208
 209
 210 /**
 211  * Bookmark Support
 212  */
 213 if (!defined('TESTSUITE')) {
 214     $GLOBALS['cfg']['Bookmark'] = PMA_Bookmark_getParams();
 215 }
 216 ?>