phpmyadmin/libraries/SavedSearches.class.php

   1 <?php
   2 /* vim: set expandtab sw=4 ts=4 sts=4: */
   3 /**
   4  * Saved searches managing
   5  *
   6  * @package PhpMyAdmin
   7  */
   8
   9 if (! defined('PHPMYADMIN')) {
  10     exit;
  11 }
  12
  13 /**
  14  * Saved searches managing
  15  *
  16  * @package PhpMyAdmin
  17  */
  18 class PMA_SavedSearches
  19 {
  20     /**
  21      * Global configuration
  22      * @var array
  23      */
  24     private $_config = null;
  25
  26     /**
  27      * Id
  28      * @var int|null
  29      */
  30     private $_id = null;
  31
  32     /**
  33      * Username
  34      * @var string
  35      */
  36     private $_username = null;
  37
  38     /**
  39      * DB name
  40      * @var string
  41      */
  42     private $_dbname = null;
  43
  44     /**
  45      * Saved search name
  46      * @var string
  47      */
  48     private $_searchName = null;
  49
  50     /**
  51      * Setter of id
  52      *
  53      * @param int|null $searchId Id of search
  54      *
  55      * @return static
  56      */
  57     public function setId($searchId)
  58     {
  59         $searchId = (int)$searchId;
  60         if (empty($searchId)) {
  61             $searchId = null;
  62         }
  63
  64         $this->_id = $searchId;
  65         return $this;
  66     }
  67
  68     /**
  69      * Getter of id
  70      *
  71      * @return int|null
  72      */
  73     public function getId()
  74     {
  75         return $this->_id;
  76     }
  77
  78     /**
  79      * Setter of searchName
  80      *
  81      * @param string $searchName Saved search name
  82      *
  83      * @return static
  84      */
  85     public function setSearchName($searchName)
  86     {
  87         $this->_searchName = $searchName;
  88         return $this;
  89     }
  90
  91     /**
  92      * Getter of searchName
  93      *
  94      * @return string
  95      */
  96     public function getSearchName()
  97     {
  98         return $this->_searchName;
  99     }
 100
 101     /**
 102      * Criterias
 103      * @var array
 104      */
 105     private $_criterias = null;
 106
 107     /**
 108      * Setter of config
 109      *
 110      * @param array $config Global configuration
 111      *
 112      * @return static
 113      */
 114     public function setConfig($config)
 115     {
 116         $this->_config = $config;
 117         return $this;
 118     }
 119
 120     /**
 121      * Getter of config
 122      *
 123      * @return array
 124      */
 125     public function getConfig()
 126     {
 127         return $this->_config;
 128     }
 129
 130     /**
 131      * Setter for criterias
 132      *
 133      * @param array|string $criterias Criterias of saved searches
 134      * @param bool         $json      Criterias are in JSON format
 135      *
 136      * @return static
 137      */
 138     public function setCriterias($criterias, $json = false)
 139     {
 140         if (true === $json && is_string($criterias)) {
 141             $this->_criterias = json_decode($criterias, true);
 142             return $this;
 143         }
 144
 145         $aListFieldsToGet = array(
 146             'criteriaColumn',
 147             'criteriaSort',
 148             'criteriaShow',
 149             'criteria',
 150             'criteriaAndOrRow',
 151             'criteriaAndOrColumn',
 152             'rows',
 153             'TableList'
 154         );
 155
 156         $data = array();
 157
 158         $data['criteriaColumnCount'] = count($criterias['criteriaColumn']);
 159
 160         foreach ($aListFieldsToGet as $field) {
 161             $data[$field] = $criterias[$field];
 162         }
 163
 164         for ($i = 0; $i <= $data['rows']; $i++) {
 165             $data['Or' . $i] = $criterias['Or' . $i];
 166         }
 167
 168         $this->_criterias = $data;
 169         return $this;
 170     }
 171
 172     /**
 173      * Getter for criterias
 174      *
 175      * @return array
 176      */
 177     public function getCriterias()
 178     {
 179         return $this->_criterias;
 180     }
 181
 182     /**
 183      * Setter for username
 184      *
 185      * @param string $username Username
 186      *
 187      * @return static
 188      */
 189     public function setUsername($username)
 190     {
 191         $this->_username = $username;
 192         return $this;
 193     }
 194
 195     /**
 196      * Getter for username
 197      *
 198      * @return string
 199      */
 200     public function getUsername()
 201     {
 202         return $this->_username;
 203     }
 204
 205     /**
 206      * Setter for DB name
 207      *
 208      * @param string $dbname DB name
 209      *
 210      * @return static
 211      */
 212     public function setDbname($dbname)
 213     {
 214         $this->_dbname = $dbname;
 215         return $this;
 216     }
 217
 218     /**
 219      * Getter for DB name
 220      *
 221      * @return string
 222      */
 223     public function getDbname()
 224     {
 225         return $this->_dbname;
 226     }
 227
 228     /**
 229      * Public constructor
 230      *
 231      * @param array $config Global configuration
 232      */
 233     public function __construct($config)
 234     {
 235         $this->setConfig($config);
 236     }
 237
 238     /**
 239      * Save the search
 240      *
 241      * @return boolean
 242      */
 243     public function save()
 244     {
 245         if (null == $this->getSearchName()) {
 246             $message = PMA_Message::error(
 247                 __('Please provide a name for this bookmarked search.')
 248             );
 249             $response = PMA_Response::getInstance();
 250             $response->isSuccess($message->isSuccess());
 251             $response->addJSON('fieldWithError', 'searchName');
 252             $response->addJSON('message', $message);
 253             exit;
 254         }
 255
 256         if (null == $this->getUsername()
 257             || null == $this->getDbname()
 258             || null == $this->getSearchName()
 259             || null == $this->getCriterias()
 260         ) {
 261             $message = PMA_Message::error(
 262                 __('Missing information to save the bookmarked search.')
 263             );
 264             $response = PMA_Response::getInstance();
 265             $response->isSuccess($message->isSuccess());
 266             $response->addJSON('message', $message);
 267             exit;
 268         }
 269
 270         $savedSearchesTbl
 271             = PMA_Util::backquote($this->_config['cfgRelation']['db']) . "."
 272             . PMA_Util::backquote($this->_config['cfgRelation']['savedsearches']);
 273
 274         //If it's an insert.
 275         if (null === $this->getId()) {
 276             $wheres = array(
 277                 "search_name = '" . PMA_Util::sqlAddSlashes($this->getSearchName())
 278                 . "'"
 279             );
 280             $existingSearches = $this->getList($wheres);
 281
 282             if (!empty($existingSearches)) {
 283                 $message = PMA_Message::error(
 284                     __('An entry with this name already exists.')
 285                 );
 286                 $response = PMA_Response::getInstance();
 287                 $response->isSuccess($message->isSuccess());
 288                 $response->addJSON('fieldWithError', 'searchName');
 289                 $response->addJSON('message', $message);
 290                 exit;
 291             }
 292
 293             $sqlQuery = "INSERT INTO " . $savedSearchesTbl
 294                 . "(`username`, `db_name`, `search_name`, `search_data`)"
 295                 . " VALUES ("
 296                 . "'" . PMA_Util::sqlAddSlashes($this->getUsername()) . "',"
 297                 . "'" . PMA_Util::sqlAddSlashes($this->getDbname()) . "',"
 298                 . "'" . PMA_Util::sqlAddSlashes($this->getSearchName()) . "',"
 299                 . "'" . PMA_Util::sqlAddSlashes(json_encode($this->getCriterias()))
 300                 . "')";
 301
 302             $result = (bool)PMA_queryAsControlUser($sqlQuery);
 303             if (!$result) {
 304                 return false;
 305             }
 306
 307             $this->setId($GLOBALS['dbi']->insertId());
 308
 309             return true;
 310         }
 311
 312         //Else, it's an update.
 313         $wheres = array(
 314             "id != " . $this->getId(),
 315             "search_name = '" . PMA_Util::sqlAddSlashes($this->getSearchName()) . "'"
 316         );
 317         $existingSearches = $this->getList($wheres);
 318
 319         if (!empty($existingSearches)) {
 320             $message = PMA_Message::error(
 321                 __('An entry with this name already exists.')
 322             );
 323             $response = PMA_Response::getInstance();
 324             $response->isSuccess($message->isSuccess());
 325             $response->addJSON('fieldWithError', 'searchName');
 326             $response->addJSON('message', $message);
 327             exit;
 328         }
 329
 330         $sqlQuery = "UPDATE " . $savedSearchesTbl
 331             . "SET `search_name` = '"
 332             . PMA_Util::sqlAddSlashes($this->getSearchName()) . "', "
 333             . "`search_data` = '"
 334             . PMA_Util::sqlAddSlashes(json_encode($this->getCriterias())) . "' "
 335             . "WHERE id = " . $this->getId();
 336         return (bool)PMA_queryAsControlUser($sqlQuery);
 337     }
 338
 339     /**
 340      * Delete the search
 341      *
 342      * @return boolean
 343      */
 344     public function delete()
 345     {
 346         if (null == $this->getId()) {
 347             $message = PMA_Message::error(
 348                 __('Missing information to delete the search.')
 349             );
 350             $response = PMA_Response::getInstance();
 351             $response->isSuccess($message->isSuccess());
 352             $response->addJSON('fieldWithError', 'searchId');
 353             $response->addJSON('message', $message);
 354             exit;
 355         }
 356
 357         $savedSearchesTbl
 358             = PMA_Util::backquote($this->_config['cfgRelation']['db']) . "."
 359             . PMA_Util::backquote($this->_config['cfgRelation']['savedsearches']);
 360
 361         $sqlQuery = "DELETE FROM " . $savedSearchesTbl
 362             . "WHERE id = '" . PMA_Util::sqlAddSlashes($this->getId()) . "'";
 363
 364         return (bool)PMA_queryAsControlUser($sqlQuery);
 365     }
 366
 367     /**
 368      * Load the current search from an id.
 369      *
 370      * @return bool Success
 371      */
 372     public function load()
 373     {
 374         if (null == $this->getId()) {
 375             $message = PMA_Message::error(
 376                 __('Missing information to load the search.')
 377             );
 378             $response = PMA_Response::getInstance();
 379             $response->isSuccess($message->isSuccess());
 380             $response->addJSON('fieldWithError', 'searchId');
 381             $response->addJSON('message', $message);
 382             exit;
 383         }
 384
 385         $savedSearchesTbl = PMA_Util::backquote($this->_config['cfgRelation']['db'])
 386             . "."
 387             . PMA_Util::backquote($this->_config['cfgRelation']['savedsearches']);
 388         $sqlQuery = "SELECT id, search_name, search_data "
 389             . "FROM " . $savedSearchesTbl . " "
 390             . "WHERE id = '" . PMA_Util::sqlAddSlashes($this->getId()) . "' ";
 391
 392         $resList = PMA_queryAsControlUser($sqlQuery);
 393
 394         if (false === ($oneResult = $GLOBALS['dbi']->fetchArray($resList))) {
 395             $message = PMA_Message::error(__('Error while loading the search.'));
 396             $response = PMA_Response::getInstance();
 397             $response->isSuccess($message->isSuccess());
 398             $response->addJSON('fieldWithError', 'searchId');
 399             $response->addJSON('message', $message);
 400             exit;
 401         }
 402
 403         $this->setSearchName($oneResult['search_name'])
 404             ->setCriterias($oneResult['search_data'], true);
 405
 406         return true;
 407     }
 408
 409     /**
 410      * Get the list of saved search of a user on a DB
 411      *
 412      * @param string[] $wheres List of filters
 413      *
 414      * @return array|bool List of saved search or false on failure
 415      */
 416     public function getList(array $wheres = array())
 417     {
 418         if (null == $this->getUsername()
 419             || null == $this->getDbname()
 420         ) {
 421             return false;
 422         }
 423
 424         $savedSearchesTbl = PMA_Util::backquote($this->_config['cfgRelation']['db'])
 425             . "."
 426             . PMA_Util::backquote($this->_config['cfgRelation']['savedsearches']);
 427         $sqlQuery = "SELECT id, search_name "
 428             . "FROM " . $savedSearchesTbl . " "
 429             . "WHERE "
 430             . "username = '" . PMA_Util::sqlAddSlashes($this->getUsername()) . "' "
 431             . "AND db_name = '" . PMA_Util::sqlAddSlashes($this->getDbname()) . "' ";
 432
 433         foreach ($wheres as $where) {
 434             $sqlQuery .= "AND " . $where . " ";
 435         }
 436
 437         $sqlQuery .= "order by search_name ASC ";
 438
 439         $resList = PMA_queryAsControlUser($sqlQuery);
 440
 441         $list = array();
 442         while ($oneResult = $GLOBALS['dbi']->fetchArray($resList)) {
 443             $list[$oneResult['id']] = $oneResult['search_name'];
 444         }
 445
 446         return $list;
 447     }
 448 }