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