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