libraries/SavedSearches.php

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