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 /**
  10  * Defines the bookmark parameters for the current user
  11  *
  12  * @uses    $GLOBALS['server']
  13  * @uses    PMA_getRelationsParam()
  14  * @uses    $GLOBALS['cfg']['Server']['user']
  15  * @uses    $GLOBALS['cfg']['Server']['pmadb']
  16  * @uses    $GLOBALS['cfg']['Server']['bookmarktable']
  17  * @return  array    the bookmark parameters for the current user
  18  * @access  public
  19  */
  20 function PMA_Bookmark_getParams()
  21 {
  22     static $cfgBookmark = null;
  23
  24     if (null !== $cfgBookmark) {
  25         return $cfgBookmark;
  26     }
  27
  28     $cfgRelation = PMA_getRelationsParam();
  29
  30     if ($cfgRelation['bookmarkwork']) {
  31         $cfgBookmark = array(
  32             'user'  => $GLOBALS['cfg']['Server']['user'],
  33             'db'    => $GLOBALS['cfg']['Server']['pmadb'],
  34             'table' => $GLOBALS['cfg']['Server']['bookmarktable'],
  35         );
  36     } else {
  37         $cfgBookmark = false;
  38     }
  39
  40     return $cfgBookmark;
  41 } // end of the 'PMA_Bookmark_getParams()' function
  42
  43
  44 /**
  45  * Gets the list of bookmarks defined for the current database
  46  *
  47  * @uses    PMA_backquote()
  48  * @uses    PMA_sqlAddslashes()
  49  * @uses    PMA_DBI_fetch_result()
  50  * @uses    PMA_DBI_QUERY_STORE
  51  * @uses    PMA_Bookmark_getParams()
  52  * @global  resource  the controluser db connection handle
  53  *
  54  * @param   string    the current database name
  55  *
  56  * @return  array     the bookmarks list (key as index, label as value)
  57  *
  58  * @access  public
  59  */
  60 function PMA_Bookmark_getList($db)
  61 {
  62     global $controllink;
  63
  64     $cfgBookmark = PMA_Bookmark_getParams();
  65
  66     if (empty($cfgBookmark)) {
  67         return array();
  68     }
  69
  70     $query  = 'SELECT label, id FROM '. PMA_backquote($cfgBookmark['db']) . '.' . PMA_backquote($cfgBookmark['table'])
  71             . ' WHERE dbase = \'' . PMA_sqlAddslashes($db) . '\''
  72             . ' AND user = \'' . PMA_sqlAddslashes($cfgBookmark['user']) . '\''
  73             . ' ORDER BY label';
  74     $per_user = PMA_DBI_fetch_result($query, 'id', 'label', $controllink, PMA_DBI_QUERY_STORE);
  75
  76     $query  = 'SELECT label, id FROM '. PMA_backquote($cfgBookmark['db']) . '.' . PMA_backquote($cfgBookmark['table'])
  77             . ' WHERE dbase = \'' . PMA_sqlAddslashes($db) . '\''
  78             . ' AND user = \'\''
  79             . ' ORDER BY label';
  80     $global = PMA_DBI_fetch_result($query, 'id', 'label', $controllink, PMA_DBI_QUERY_STORE);
  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  * @uses    PMA_backquote()
  98  * @uses    PMA_sqlAddslashes()
  99  * @uses    PMA_DBI_fetch_value()
 100  * @uses    PMA_Bookmark_getParams()
 101  * @global  resource  the controluser db connection handle
 102  *
 103  * @param   string    the current database name
 104  * @param   mixed     the id of the bookmark to get
 105  * @param   string    which field to look up the $id
 106  * @param   boolean  TRUE: get all bookmarks regardless of the owning user
 107  * @param   boolean   whether to ignore bookmarks with no user
 108  *
 109  * @return  string    the sql query
 110  *
 111  * @access  public
 112  */
 113 function PMA_Bookmark_get($db, $id, $id_field = 'id', $action_bookmark_all = FALSE, $exact_user_match = FALSE)
 114 {
 115     global $controllink;
 116
 117     $cfgBookmark = PMA_Bookmark_getParams();
 118
 119     if (empty($cfgBookmark)) {
 120         return '';
 121     }
 122
 123     $query = 'SELECT query FROM ' . PMA_backquote($cfgBookmark['db']) . '.' . PMA_backquote($cfgBookmark['table'])
 124         . ' WHERE dbase = \'' . PMA_sqlAddslashes($db) . '\'';
 125
 126     if (!$action_bookmark_all) {
 127         $query .= ' AND (user = \'' . PMA_sqlAddslashes($cfgBookmark['user']) . '\'';
 128         if (!$exact_user_match) {
 129             $query .= ' OR user = \'\'';
 130         }
 131         $query .= ')';
 132     }
 133
 134     $query .= ' AND ' . PMA_backquote($id_field) . ' = ' . $id;
 135
 136     return PMA_DBI_fetch_value($query, 0, 0, $controllink);
 137 } // end of the 'PMA_Bookmark_get()' function
 138
 139 /**
 140  * Adds a bookmark
 141  *
 142  * @uses    PMA_backquote()
 143  * @uses    PMA_sqlAddslashes()
 144  * @uses    PMA_DBI_query()
 145  * @uses    PMA_Bookmark_getParams()
 146  * @global  resource  the controluser db connection handle
 147  *
 148  * @param   array     the properties of the bookmark to add; here,
 149  *                    $fields['query'] is urlencoded
 150  * @param   boolean   whether to make the bookmark available for all users
 151  *
 152  * @return  boolean   whether the INSERT succeeds or not
 153  *
 154  * @access  public
 155  */
 156 function PMA_Bookmark_save($fields, $all_users = false)
 157 {
 158     global $controllink;
 159
 160     $cfgBookmark = PMA_Bookmark_getParams();
 161
 162     if (empty($cfgBookmark)) {
 163         return false;
 164     }
 165
 166     $query = 'INSERT INTO ' . PMA_backquote($cfgBookmark['db']) . '.' . PMA_backquote($cfgBookmark['table'])
 167            . ' (id, dbase, user, query, label) VALUES (NULL, \'' . PMA_sqlAddslashes($fields['dbase']) . '\', \'' . ($all_users ? '' : PMA_sqlAddslashes($fields['user'])) . '\', \'' . PMA_sqlAddslashes(urldecode($fields['query'])) . '\', \'' . PMA_sqlAddslashes($fields['label']) . '\')';
 168     return PMA_DBI_query($query, $controllink);
 169 } // end of the 'PMA_Bookmark_save()' function
 170
 171
 172 /**
 173  * Deletes a bookmark
 174  *
 175  * @uses    PMA_backquote()
 176  * @uses    PMA_sqlAddslashes()
 177  * @uses    PMA_DBI_try_query()
 178  * @uses    PMA_Bookmark_getParams()
 179  * @global  resource  the controluser db connection handle
 180  *
 181  * @param   string   the current database name
 182  * @param   integer  the id of the bookmark to get
 183  *
 184  * @access  public
 185  */
 186 function PMA_Bookmark_delete($db, $id)
 187 {
 188     global $controllink;
 189
 190     $cfgBookmark = PMA_Bookmark_getParams();
 191
 192     if (empty($cfgBookmark)) {
 193         return false;
 194     }
 195
 196     $query  = 'DELETE FROM ' . PMA_backquote($cfgBookmark['db']) . '.' . PMA_backquote($cfgBookmark['table'])
 197             . ' WHERE (user = \'' . PMA_sqlAddslashes($cfgBookmark['user']) . '\''
 198             . '        OR user = \'\')'
 199             . ' AND id = ' . $id;
 200     return PMA_DBI_try_query($query, $controllink);
 201 } // end of the 'PMA_Bookmark_delete()' function
 202
 203
 204 /**
 205  * Bookmark Support
 206  */
 207 $GLOBALS['cfg']['Bookmark'] = PMA_Bookmark_getParams();
 208
 209 ?>