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             if (isset($criterias[$field])) {
 159                 $data[$field] = $criterias[$field];
 160             }
 161         }
 162
 163         /* Limit amount of rows */
 164         if (!isset($data['rows'])) {
 165             $data['rows'] = 0;
 166         } else {
 167             $data['rows'] = min(
 168                 max(0, intval($data['rows'])),
 169                 100
 170             );
 171         }
 172
 173         for ($i = 0; $i <= $data['rows']; $i++) {
 174             $data['Or' . $i] = $criterias['Or' . $i];
 175         }
 176
 177         $this->_criterias = $data;
 178         return $this;
 179     }
 180
 181     /**
 182      * Getter for criterias
 183      *
 184      * @return array
 185      */
 186     public function getCriterias()
 187     {
 188         return $this->_criterias;
 189     }
 190
 191     /**
 192      * Setter for username
 193      *
 194      * @param string $username Username
 195      *
 196      * @return static
 197      */
 198     public function setUsername($username)
 199     {
 200         $this->_username = $username;
 201         return $this;
 202     }
 203
 204     /**
 205      * Getter for username
 206      *
 207      * @return string
 208      */
 209     public function getUsername()
 210     {
 211         return $this->_username;
 212     }
 213
 214     /**
 215      * Setter for DB name
 216      *
 217      * @param string $dbname DB name
 218      *
 219      * @return static
 220      */
 221     public function setDbname($dbname)
 222     {
 223         $this->_dbname = $dbname;
 224         return $this;
 225     }
 226
 227     /**
 228      * Getter for DB name
 229      *
 230      * @return string
 231      */
 232     public function getDbname()
 233     {
 234         return $this->_dbname;
 235     }
 236
 237     /**
 238      * Public constructor
 239      *
 240      * @param array $config Global configuration
 241      */
 242     public function __construct($config)
 243     {
 244         $this->setConfig($config);
 245     }
 246
 247     /**
 248      * Save the search
 249      *
 250      * @return boolean
 251      */
 252     public function save()
 253     {
 254         if (null == $this->getSearchName()) {
 255             $message = Message::error(
 256                 __('Please provide a name for this bookmarked search.')
 257             );
 258             $response = Response::getInstance();
 259             $response->setRequestStatus($message->isSuccess());
 260             $response->addJSON('fieldWithError', 'searchName');
 261             $response->addJSON('message', $message);
 262             exit;
 263         }
 264
 265         if (null == $this->getUsername()
 266             || null == $this->getDbname()
 267             || null == $this->getSearchName()
 268             || null == $this->getCriterias()
 269         ) {
 270             $message = Message::error(
 271                 __('Missing information to save the bookmarked search.')
 272             );
 273             $response = Response::getInstance();
 274             $response->setRequestStatus($message->isSuccess());
 275             $response->addJSON('message', $message);
 276             exit;
 277         }
 278
 279         $savedSearchesTbl
 280             = Util::backquote($this->_config['cfgRelation']['db']) . "."
 281             . Util::backquote($this->_config['cfgRelation']['savedsearches']);
 282
 283         //If it's an insert.
 284         if (null === $this->getId()) {
 285             $wheres = array(
 286                 "search_name = '" . $GLOBALS['dbi']->escapeString($this->getSearchName())
 287                 . "'"
 288             );
 289             $existingSearches = $this->getList($wheres);
 290
 291             if (!empty($existingSearches)) {
 292                 $message = Message::error(
 293                     __('An entry with this name already exists.')
 294                 );
 295                 $response = Response::getInstance();
 296                 $response->setRequestStatus($message->isSuccess());
 297                 $response->addJSON('fieldWithError', 'searchName');
 298                 $response->addJSON('message', $message);
 299                 exit;
 300             }
 301
 302             $sqlQuery = "INSERT INTO " . $savedSearchesTbl
 303                 . "(`username`, `db_name`, `search_name`, `search_data`)"
 304                 . " VALUES ("
 305                 . "'" . $GLOBALS['dbi']->escapeString($this->getUsername()) . "',"
 306                 . "'" . $GLOBALS['dbi']->escapeString($this->getDbname()) . "',"
 307                 . "'" . $GLOBALS['dbi']->escapeString($this->getSearchName()) . "',"
 308                 . "'" . $GLOBALS['dbi']->escapeString(json_encode($this->getCriterias()))
 309                 . "')";
 310
 311             $result = (bool)PMA_queryAsControlUser($sqlQuery);
 312             if (!$result) {
 313                 return false;
 314             }
 315
 316             $this->setId($GLOBALS['dbi']->insertId());
 317
 318             return true;
 319         }
 320
 321         //Else, it's an update.
 322         $wheres = array(
 323             "id != " . $this->getId(),
 324             "search_name = '" . $GLOBALS['dbi']->escapeString($this->getSearchName()) . "'"
 325         );
 326         $existingSearches = $this->getList($wheres);
 327
 328         if (!empty($existingSearches)) {
 329             $message = Message::error(
 330                 __('An entry with this name already exists.')
 331             );
 332             $response = Response::getInstance();
 333             $response->setRequestStatus($message->isSuccess());
 334             $response->addJSON('fieldWithError', 'searchName');
 335             $response->addJSON('message', $message);
 336             exit;
 337         }
 338
 339         $sqlQuery = "UPDATE " . $savedSearchesTbl
 340             . "SET `search_name` = '"
 341             . $GLOBALS['dbi']->escapeString($this->getSearchName()) . "', "
 342             . "`search_data` = '"
 343             . $GLOBALS['dbi']->escapeString(json_encode($this->getCriterias())) . "' "
 344             . "WHERE id = " . $this->getId();
 345         return (bool)PMA_queryAsControlUser($sqlQuery);
 346     }
 347
 348     /**
 349      * Delete the search
 350      *
 351      * @return boolean
 352      */
 353     public function delete()
 354     {
 355         if (null == $this->getId()) {
 356             $message = Message::error(
 357                 __('Missing information to delete the search.')
 358             );
 359             $response = Response::getInstance();
 360             $response->setRequestStatus($message->isSuccess());
 361             $response->addJSON('fieldWithError', 'searchId');
 362             $response->addJSON('message', $message);
 363             exit;
 364         }
 365
 366         $savedSearchesTbl
 367             = Util::backquote($this->_config['cfgRelation']['db']) . "."
 368             . Util::backquote($this->_config['cfgRelation']['savedsearches']);
 369
 370         $sqlQuery = "DELETE FROM " . $savedSearchesTbl
 371             . "WHERE id = '" . $GLOBALS['dbi']->escapeString($this->getId()) . "'";
 372
 373         return (bool)PMA_queryAsControlUser($sqlQuery);
 374     }
 375
 376     /**
 377      * Load the current search from an id.
 378      *
 379      * @return bool Success
 380      */
 381     public function load()
 382     {
 383         if (null == $this->getId()) {
 384             $message = Message::error(
 385                 __('Missing information to load the search.')
 386             );
 387             $response = Response::getInstance();
 388             $response->setRequestStatus($message->isSuccess());
 389             $response->addJSON('fieldWithError', 'searchId');
 390             $response->addJSON('message', $message);
 391             exit;
 392         }
 393
 394         $savedSearchesTbl = Util::backquote($this->_config['cfgRelation']['db'])
 395             . "."
 396             . Util::backquote($this->_config['cfgRelation']['savedsearches']);
 397         $sqlQuery = "SELECT id, search_name, search_data "
 398             . "FROM " . $savedSearchesTbl . " "
 399             . "WHERE id = '" . $GLOBALS['dbi']->escapeString($this->getId()) . "' ";
 400
 401         $resList = PMA_queryAsControlUser($sqlQuery);
 402
 403         if (false === ($oneResult = $GLOBALS['dbi']->fetchArray($resList))) {
 404             $message = Message::error(__('Error while loading the search.'));
 405             $response = Response::getInstance();
 406             $response->setRequestStatus($message->isSuccess());
 407             $response->addJSON('fieldWithError', 'searchId');
 408             $response->addJSON('message', $message);
 409             exit;
 410         }
 411
 412         $this->setSearchName($oneResult['search_name'])
 413             ->setCriterias($oneResult['search_data'], true);
 414
 415         return true;
 416     }
 417
 418     /**
 419      * Get the list of saved searches of a user on a DB
 420      *
 421      * @param string[] $wheres List of filters
 422      *
 423      * @return array List of saved searches or empty array on failure
 424      */
 425     public function getList(array $wheres = array())
 426     {
 427         if (null == $this->getUsername()
 428             || null == $this->getDbname()
 429         ) {
 430             return array();
 431         }
 432
 433         $savedSearchesTbl = Util::backquote($this->_config['cfgRelation']['db'])
 434             . "."
 435             . Util::backquote($this->_config['cfgRelation']['savedsearches']);
 436         $sqlQuery = "SELECT id, search_name "
 437             . "FROM " . $savedSearchesTbl . " "
 438             . "WHERE "
 439             . "username = '" . $GLOBALS['dbi']->escapeString($this->getUsername()) . "' "
 440             . "AND db_name = '" . $GLOBALS['dbi']->escapeString($this->getDbname()) . "' ";
 441
 442         foreach ($wheres as $where) {
 443             $sqlQuery .= "AND " . $where . " ";
 444         }
 445
 446         $sqlQuery .= "order by search_name ASC ";
 447
 448         $resList = PMA_queryAsControlUser($sqlQuery);
 449
 450         $list = array();
 451         while ($oneResult = $GLOBALS['dbi']->fetchArray($resList)) {
 452             $list[$oneResult['id']] = $oneResult['search_name'];
 453         }
 454
 455         return $list;
 456     }
 457 }