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  * @version $Id$
   7  */
   8
   9
  10 /**
  11  * Defines the bookmark parameters for the current user
  12  *
  13  * @return  array    the bookmark parameters for the current user
  14  *
  15  * @global  integer  the id of the current server
  16  *
  17  * @access  public
  18  */
  19 function PMA_getBookmarksParam()
  20 {
  21     global $server;
  22
  23     $cfgBookmark = '';
  24
  25     // No server selected -> no bookmark table
  26     if ($server == 0) {
  27         return '';
  28     }
  29
  30     $cfgBookmark['user']  = $GLOBALS['cfg']['Server']['user'];
  31     $cfgBookmark['db']    = $GLOBALS['cfg']['Server']['pmadb'];
  32     $cfgBookmark['table'] = $GLOBALS['cfg']['Server']['bookmarktable'];
  33
  34     return $cfgBookmark;
  35 } // end of the 'PMA_getBookmarksParam()' function
  36
  37
  38 /**
  39  * Gets the list of bookmarks defined for the current database
  40  *
  41  * @global  resource  the controluser db connection handle
  42  *
  43  * @param   string    the current database name
  44  * @param   array     the bookmark parameters for the current user
  45  *
  46  * @return  mixed     the bookmarks list if defined, false else
  47  *
  48  * @access  public
  49  */
  50 function PMA_listBookmarks($db, $cfgBookmark)
  51 {
  52     global $controllink;
  53
  54     if (empty($cfgBookmark['db']) || empty($cfgBookmark['table'])) {
  55         return '';
  56     }
  57
  58     $query  = 'SELECT label, id FROM '. PMA_backquote($cfgBookmark['db']) . '.' . PMA_backquote($cfgBookmark['table'])
  59             . ' WHERE dbase = \'' . PMA_sqlAddslashes($db) . '\''
  60             . ' AND (user = \'' . PMA_sqlAddslashes($cfgBookmark['user']) . '\''
  61             . '      OR user = \'\')'
  62             . ' ORDER BY label';
  63     $result = PMA_DBI_query($query, $controllink, PMA_DBI_QUERY_STORE);
  64
  65     // There are some bookmarks -> store them
  66     // use the unique id as the key
  67     if ($result && PMA_DBI_num_rows($result) > 0) {
  68         while ($row = PMA_DBI_fetch_row($result)) {
  69             $bookmark_list[$row[1]] = $row[0];
  70         } // end while
  71         return $bookmark_list;
  72     }
  73     // No bookmarks for the current database
  74     else {
  75         return FALSE;
  76     }
  77 } // end of the 'PMA_listBookmarks()' function
  78
  79
  80 /**
  81  * Gets the sql command from a bookmark
  82  *
  83  * @global  resource  the controluser db connection handle
  84  *
  85  * @param   string    the current database name
  86  * @param   array     the bookmark parameters for the current user
  87  * @param   mixed     the id of the bookmark to get
  88  * @param   string    which field to look up the $id
  89  * @param   boolean  TRUE: get all bookmarks regardless of the owning user
  90  * @param   boolean   whether to ignore bookmarks with no user
  91  *
  92  * @return  string    the sql query
  93  *
  94  * @access  public
  95  */
  96 function PMA_queryBookmarks($db, $cfgBookmark, $id, $id_field = 'id', $action_bookmark_all = FALSE, $exact_user_match = FALSE)
  97 {
  98     global $controllink;
  99
 100     if (empty($cfgBookmark['db']) || empty($cfgBookmark['table'])) {
 101         return '';
 102     }
 103
 104     $query = 'SELECT query FROM ' . PMA_backquote($cfgBookmark['db']) . '.' . PMA_backquote($cfgBookmark['table'])
 105         . ' WHERE dbase = \'' . PMA_sqlAddslashes($db) . '\'';
 106
 107     if (!$action_bookmark_all) {
 108         $query .= ' AND (user = \'' . PMA_sqlAddslashes($cfgBookmark['user']) . '\'';
 109         if (!$exact_user_match) {
 110             $query .= ' OR user = \'\'';
 111         }
 112         $query .= ')';
 113     }
 114
 115     $query .= ' AND ' . PMA_backquote($id_field) . ' = ' . $id;
 116
 117     $result = PMA_DBI_try_query($query, $controllink);
 118     if (!$result) {
 119         return FALSE;
 120     }
 121     list($bookmark_query) = PMA_DBI_fetch_row($result) or array(FALSE);
 122
 123     return $bookmark_query;
 124 } // end of the 'PMA_queryBookmarks()' function
 125
 126 /**
 127  * Adds a bookmark
 128  *
 129  * @global  resource  the controluser db connection handle
 130  *
 131  * @param   array     the properties of the bookmark to add
 132  * @param   array     the bookmark parameters for the current user
 133  * @param   boolean   whether to make the bookmark available for all users
 134  *
 135  * @return  boolean   whether the INSERT succeeds or not
 136  *
 137  * @access  public
 138  */
 139 function PMA_addBookmarks($fields, $cfgBookmark, $all_users = false)
 140 {
 141     global $controllink;
 142
 143     $query = 'INSERT INTO ' . PMA_backquote($cfgBookmark['db']) . '.' . PMA_backquote($cfgBookmark['table'])
 144            . ' (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']) . '\')';
 145     $result   = PMA_DBI_query($query, $controllink);
 146
 147     return TRUE;
 148 } // end of the 'PMA_addBookmarks()' function
 149
 150
 151 /**
 152  * Deletes a bookmark
 153  *
 154  * @global  resource  the controluser db connection handle
 155  *
 156  * @param   string   the current database name
 157  * @param   array    the bookmark parameters for the current user
 158  * @param   integer  the id of the bookmark to get
 159  *
 160  * @access  public
 161  */
 162 function PMA_deleteBookmarks($db, $cfgBookmark, $id)
 163 {
 164     global $controllink;
 165
 166     $query  = 'DELETE FROM ' . PMA_backquote($cfgBookmark['db']) . '.' . PMA_backquote($cfgBookmark['table'])
 167             . ' WHERE (user = \'' . PMA_sqlAddslashes($cfgBookmark['user']) . '\''
 168             . '        OR user = \'\')'
 169             . ' AND id = ' . $id;
 170     $result = PMA_DBI_try_query($query, $controllink);
 171 } // end of the 'PMA_deleteBookmarks()' function
 172
 173
 174 /**
 175  * Bookmark Support
 176  */
 177
 178 if (! isset($GLOBALS['cfgRelation'])) {
 179     require_once './libraries/relation.lib.php';
 180     $GLOBALS['cfgRelation'] = PMA_getRelationsParam();
 181 }
 182
 183 if ($GLOBALS['cfgRelation']['bookmarkwork']) {
 184     $cfg['Bookmark'] = PMA_getBookmarksParam();
 185 } else {
 186     $cfg['Bookmark'] = array();
 187 }
 188
 189 ?>