ConfigSetting.php 18.4 KB
Newer Older
totten's avatar
totten committed
1 2 3
<?php
/*
 +--------------------------------------------------------------------+
Kurund Jalmi's avatar
Kurund Jalmi committed
4
 | CiviCRM version 4.7                                                |
totten's avatar
totten committed
5
 +--------------------------------------------------------------------+
colemanw's avatar
colemanw committed
6
 | Copyright CiviCRM LLC (c) 2004-2015                                |
totten's avatar
totten committed
7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25
 +--------------------------------------------------------------------+
 | This file is a part of CiviCRM.                                    |
 |                                                                    |
 | CiviCRM is free software; you can copy, modify, and distribute it  |
 | under the terms of the GNU Affero General Public License           |
 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
 |                                                                    |
 | CiviCRM is distributed in the hope that it will be useful, but     |
 | WITHOUT ANY WARRANTY; without even the implied warranty of         |
 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
 | See the GNU Affero General Public License for more details.        |
 |                                                                    |
 | You should have received a copy of the GNU Affero General Public   |
 | License and the CiviCRM Licensing Exception along                  |
 | with this program; if not, contact CiviCRM LLC                     |
 | at info[AT]civicrm[DOT]org. If you have questions about the        |
 | GNU Affero General Public License or the licensing of CiviCRM,     |
 | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
 +--------------------------------------------------------------------+
26
 */
totten's avatar
totten committed
27 28 29 30 31

/**
 *
 *
 * @package CRM
colemanw's avatar
colemanw committed
32
 * @copyright CiviCRM LLC (c) 2004-2015
totten's avatar
totten committed
33 34 35
 */

/**
eileenmcnaugton's avatar
eileenmcnaugton committed
36
 * File contains functions used in civicrm configuration.
totten's avatar
totten committed
37 38 39 40
 */
class CRM_Core_BAO_ConfigSetting {

  /**
colemanw's avatar
colemanw committed
41
   * Create civicrm settings. This is the same as add but it clears the cache and
lobo's avatar
lobo committed
42
   * reloads the config object
totten's avatar
totten committed
43
   *
44 45
   * @param array $params
   *   Associated array of civicrm variables.
totten's avatar
totten committed
46
   */
47
  public static function create($params) {
totten's avatar
totten committed
48 49 50
    self::add($params);
    $cache = CRM_Utils_Cache::singleton();
    $cache->delete('CRM_Core_Config');
eileen's avatar
eileen committed
51
    $cache->delete('CRM_Core_Config' . CRM_Core_Config::domainID());
totten's avatar
totten committed
52 53 54 55
    $config = CRM_Core_Config::singleton(TRUE, TRUE);
  }

  /**
56
   * Add civicrm settings.
totten's avatar
totten committed
57
   *
58 59
   * @param array $params
   *   Associated array of civicrm variables.
totten's avatar
totten committed
60
   */
61
  public static function add(&$params) {
totten's avatar
totten committed
62 63 64 65
    $domain = new CRM_Core_DAO_Domain();
    $domain->id = CRM_Core_Config::domainID();
    $domain->find(TRUE);
    if ($domain->config_backend) {
66
      $params = array_merge(unserialize($domain->config_backend), $params);
totten's avatar
totten committed
67 68
    }

69
    $params = CRM_Core_BAO_ConfigSetting::filterSkipVars($params);
totten's avatar
totten committed
70 71 72 73 74 75 76 77 78 79 80 81 82

    // also skip all Dir Params, we dont need to store those in the DB!
    foreach ($params as $name => $val) {
      if (substr($name, -3) == 'Dir') {
        unset($params[$name]);
      }
    }

    $domain->config_backend = serialize($params);
    $domain->save();
  }

  /**
83
   * Retrieve the settings values from db.
totten's avatar
totten committed
84
   *
Eileen McNaughton's avatar
Eileen McNaughton committed
85 86
   * @param $defaults
   *
87
   * @return array
totten's avatar
totten committed
88
   */
89
  public static function retrieve(&$defaults) {
totten's avatar
totten committed
90 91 92 93 94 95 96 97 98 99 100 101
    $domain = new CRM_Core_DAO_Domain();

    //we are initializing config, really can't use, CRM-7863
    $urlVar = 'q';
    if (defined('CIVICRM_UF') && CIVICRM_UF == 'Joomla') {
      $urlVar = 'task';
    }

    if (CRM_Core_Config::isUpgradeMode()) {
      $domain->selectAdd('config_backend');
    }
    else {
102
      $domain->selectAdd('config_backend, locales');
totten's avatar
totten committed
103 104 105 106 107 108 109 110
    }

    $domain->id = CRM_Core_Config::domainID();
    $domain->find(TRUE);
    if ($domain->config_backend) {
      $defaults = unserialize($domain->config_backend);
      if ($defaults === FALSE || !is_array($defaults)) {
        $defaults = array();
kurund's avatar
kurund committed
111
        return FALSE;
totten's avatar
totten committed
112 113 114 115 116 117 118 119 120
      }

      $skipVars = self::skipVars();
      foreach ($skipVars as $skip) {
        if (array_key_exists($skip, $defaults)) {
          unset($defaults[$skip]);
        }
      }

121 122 123
      CRM_Core_BAO_ConfigSetting::applyLocale(Civi::settings($domain->id), $domain->locales);
    }
  }
totten's avatar
totten committed
124

125 126 127 128 129 130 131 132 133 134 135
  /**
   * Evaluate locale preferences and activate a chosen locale by
   * updating session+global variables.
   *
   * @param \Civi\Core\SettingsBag $settings
   * @param string $activatedLocales
   *   Imploded list of locales which are supported in the DB.
   */
  public static function applyLocale($settings, $activatedLocales) {
    // are we in a multi-language setup?
    $multiLang = $activatedLocales ? TRUE : FALSE;
totten's avatar
totten committed
136

137 138
    // set the current language
    $chosenLocale = NULL;
totten's avatar
totten committed
139

140
    $session = CRM_Core_Session::singleton();
totten's avatar
totten committed
141

142 143 144 145 146 147
    // on multi-lang sites based on request and civicrm_uf_match
    if ($multiLang) {
      $languageLimit = array();
      if (is_array($settings->get('languageLimit'))) {
        $languageLimit = $settings->get('languageLimit');
      }
totten's avatar
totten committed
148

149 150 151
      $requestLocale = CRM_Utils_Request::retrieve('lcMessages', 'String');
      if (in_array($requestLocale, array_keys($languageLimit))) {
        $chosenLocale = $requestLocale;
totten's avatar
totten committed
152

153 154 155 156 157 158 159
        //CRM-8559, cache navigation do not respect locale if it is changed, so reseting cache.
        // Ed: This doesn't sound good.
        CRM_Core_BAO_Cache::deleteGroup('navigation');
      }
      else {
        $requestLocale = NULL;
      }
totten's avatar
totten committed
160

161 162 163 164 165 166 167
      if (!$requestLocale) {
        $sessionLocale = $session->get('lcMessages');
        if (in_array($sessionLocale, array_keys($languageLimit))) {
          $chosenLocale = $sessionLocale;
        }
        else {
          $sessionLocale = NULL;
totten's avatar
totten committed
168
        }
169
      }
totten's avatar
totten committed
170

171 172 173 174 175 176
      if ($requestLocale) {
        $ufm = new CRM_Core_DAO_UFMatch();
        $ufm->contact_id = $session->get('userID');
        if ($ufm->find(TRUE)) {
          $ufm->language = $chosenLocale;
          $ufm->save();
totten's avatar
totten committed
177
        }
178
        $session->set('lcMessages', $chosenLocale);
totten's avatar
totten committed
179
      }
180 181 182 183 184 185

      if (!$chosenLocale and $session->get('userID')) {
        $ufm = new CRM_Core_DAO_UFMatch();
        $ufm->contact_id = $session->get('userID');
        if ($ufm->find(TRUE) &&
          in_array($ufm->language, array_keys($languageLimit))
Eileen McNaughton's avatar
Eileen McNaughton committed
186
        ) {
187
          $chosenLocale = $ufm->language;
totten's avatar
totten committed
188
        }
189
        $session->set('lcMessages', $chosenLocale);
totten's avatar
totten committed
190
      }
191 192 193 194 195 196 197 198 199 200
    }
    global $dbLocale;

    // try to inherit the language from the hosting CMS
    if ($settings->get('inheritLocale')) {
      // FIXME: On multilanguage installs, CRM_Utils_System::getUFLocale() in many cases returns nothing if $dbLocale is not set
      $dbLocale = $multiLang ? ("_" . $settings->get('lcMessages')) : '';
      $chosenLocale = CRM_Utils_System::getUFLocale();
      if ($activatedLocales and !in_array($chosenLocale, explode(CRM_Core_DAO::VALUE_SEPARATOR, $activatedLocales))) {
        $chosenLocale = NULL;
201
      }
202
    }
totten's avatar
totten committed
203

204 205 206 207
    if (empty($chosenLocale)) {
      //CRM-11993 - if a single-lang site, use default
      $chosenLocale = $settings->get('lcMessages');
    }
totten's avatar
totten committed
208

209 210
    // set suffix for table names - use views if more than one language
    $dbLocale = $multiLang ? "_{$chosenLocale}" : '';
totten's avatar
totten committed
211

212 213 214 215 216 217 218 219
    // FIXME: an ugly hack to fix CRM-4041
    global $tsLocale;
    $tsLocale = $chosenLocale;

    // FIXME: as bad aplace as any to fix CRM-5428
    // (to be moved to a sane location along with the above)
    if (function_exists('mb_internal_encoding')) {
      mb_internal_encoding('UTF-8');
totten's avatar
totten committed
220 221 222
    }
  }

223 224 225
  /**
   * @return array
   */
226
  public static function getConfigSettings() {
totten's avatar
totten committed
227 228 229 230
    $config = CRM_Core_Config::singleton();

    $url = $dir = $siteName = $siteRoot = NULL;
    if ($config->userFramework == 'Joomla') {
lobo's avatar
lobo committed
231 232
      $url = preg_replace(
        '|administrator/components/com_civicrm/civicrm/|',
totten's avatar
totten committed
233 234 235 236 237 238 239
        '',
        $config->userFrameworkResourceURL
      );

      // lets use imageUploadDir since we dont mess around with its values
      // in the config object, lets kep it a bit generic since folks
      // might have different values etc
Eileen McNaughton's avatar
Eileen McNaughton committed
240 241 242 243 244 245 246

      //CRM-15365 - Fix preg_replace to handle backslash for Windows File Paths
      if (DIRECTORY_SEPARATOR == '\\') {
        $dir = preg_replace(
          '|civicrm[/\\\\]templates_c[/\\\\].*$|',
          '',
          $config->templateCompileDir
247
        );
Eileen McNaughton's avatar
Eileen McNaughton committed
248 249 250 251 252 253
      }
      else {
        $dir = preg_replace(
          '|civicrm/templates_c/.*$|',
          '',
          $config->templateCompileDir
254
        );
Eileen McNaughton's avatar
Eileen McNaughton committed
255 256
      }

lobo's avatar
lobo committed
257 258 259 260 261 262
      $siteRoot = preg_replace(
        '|/media/civicrm/.*$|',
        '',
        $config->imageUploadDir
      );
    }
263
    elseif ($config->userFramework == 'WordPress') {
lobo's avatar
lobo committed
264 265 266 267 268 269 270 271 272
      $url = preg_replace(
        '|wp-content/plugins/civicrm/civicrm/|',
        '',
        $config->userFrameworkResourceURL
      );

      // lets use imageUploadDir since we dont mess around with its values
      // in the config object, lets kep it a bit generic since folks
      // might have different values etc
Eileen McNaughton's avatar
Eileen McNaughton committed
273 274 275 276 277 278 279

      //CRM-15365 - Fix preg_replace to handle backslash for Windows File Paths
      if (DIRECTORY_SEPARATOR == '\\') {
        $dir = preg_replace(
          '|civicrm[/\\\\]templates_c[/\\\\].*$|',
          '',
          $config->templateCompileDir
280
        );
Eileen McNaughton's avatar
Eileen McNaughton committed
281 282 283 284 285 286
      }
      else {
        $dir = preg_replace(
          '|civicrm/templates_c/.*$|',
          '',
          $config->templateCompileDir
287
        );
Eileen McNaughton's avatar
Eileen McNaughton committed
288 289
      }

lobo's avatar
lobo committed
290 291
      $siteRoot = preg_replace(
        '|/wp-content/plugins/files/civicrm/.*$|',
totten's avatar
totten committed
292 293 294 295 296
        '',
        $config->imageUploadDir
      );
    }
    else {
lobo's avatar
lobo committed
297 298
      $url = preg_replace(
        '|sites/[\w\.\-\_]+/modules/civicrm/|',
totten's avatar
totten committed
299 300 301 302 303 304 305
        '',
        $config->userFrameworkResourceURL
      );

      // lets use imageUploadDir since we dont mess around with its values
      // in the config object, lets kep it a bit generic since folks
      // might have different values etc
Eileen McNaughton's avatar
Eileen McNaughton committed
306 307 308 309 310 311 312

      //CRM-15365 - Fix preg_replace to handle backslash for Windows File Paths
      if (DIRECTORY_SEPARATOR == '\\') {
        $dir = preg_replace(
          '|[/\\\\]files[/\\\\]civicrm[/\\\\].*$|',
          '\\\\files\\\\',
          $config->imageUploadDir
313
        );
Eileen McNaughton's avatar
Eileen McNaughton committed
314 315 316 317 318 319
      }
      else {
        $dir = preg_replace(
          '|/files/civicrm/.*$|',
          '/files/',
          $config->imageUploadDir
320
        );
Eileen McNaughton's avatar
Eileen McNaughton committed
321 322
      }

totten's avatar
totten committed
323
      $matches = array();
lobo's avatar
lobo committed
324
      if (preg_match(
Eileen McNaughton's avatar
Eileen McNaughton committed
325 326 327 328
        '|/sites/([\w\.\-\_]+)/|',
        $config->imageUploadDir,
        $matches
      )) {
totten's avatar
totten committed
329 330 331 332 333 334 335 336 337 338 339 340 341 342
        $siteName = $matches[1];
        if ($siteName) {
          $siteName = "/sites/$siteName/";
          $siteNamePos = strpos($dir, $siteName);
          if ($siteNamePos !== FALSE) {
            $siteRoot = substr($dir, 0, $siteNamePos);
          }
        }
      }
    }

    return array($url, $dir, $siteName, $siteRoot);
  }

Eileen McNaughton's avatar
Eileen McNaughton committed
343
  /**
344
   * Return likely default settings.
345 346
   * @return array
   *   site settings
347 348 349 350
   *   - $url
   *   - $dir Base Directory
   *   - $siteName
   *   - $siteRoot
Eileen McNaughton's avatar
Eileen McNaughton committed
351
   */
352
  public static function getBestGuessSettings() {
totten's avatar
totten committed
353
    $config = CRM_Core_Config::singleton();
Eileen McNaughton's avatar
Eileen McNaughton committed
354 355 356 357 358 359 360 361 362 363

    //CRM-15365 - Fix preg_replace to handle backslash for Windows File Paths
    if (DIRECTORY_SEPARATOR == '\\') {
      $needle = 'civicrm[/\\\\]templates_c[/\\\\].*$';
    }
    else {
      $needle = 'civicrm/templates_c/.*$';
    }

    $dir = preg_replace(
364
      "|$needle|",
totten's avatar
totten committed
365 366 367 368
      '',
      $config->templateCompileDir
    );

369
    list($url, $siteName, $siteRoot) = $config->userSystem->getDefaultSiteSettings($dir);
totten's avatar
totten committed
370 371 372
    return array($url, $dir, $siteName, $siteRoot);
  }

373 374 375 376 377 378
  /**
   * @param array $defaultValues
   *
   * @return string
   * @throws Exception
   */
379
  public static function doSiteMove($defaultValues = array()) {
totten's avatar
totten committed
380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467
    $moveStatus = ts('Beginning site move process...') . '<br />';
    // get the current and guessed values
    list($oldURL, $oldDir, $oldSiteName, $oldSiteRoot) = self::getConfigSettings();
    list($newURL, $newDir, $newSiteName, $newSiteRoot) = self::getBestGuessSettings();

    // retrieve these values from the argument list
    $variables = array('URL', 'Dir', 'SiteName', 'SiteRoot', 'Val_1', 'Val_2', 'Val_3');
    $states = array('old', 'new');
    foreach ($variables as $varSuffix) {
      foreach ($states as $state) {
        $var = "{$state}{$varSuffix}";
        if (!isset($$var)) {
          if (isset($defaultValues[$var])) {
            $$var = $defaultValues[$var];
          }
          else {
            $$var = NULL;
          }
        }
        $$var = CRM_Utils_Request::retrieve($var,
          'String',
          CRM_Core_DAO::$_nullArray,
          FALSE,
          $$var,
          'REQUEST'
        );
      }
    }

    $from = $to = array();
    foreach ($variables as $varSuffix) {
      $oldVar = "old{$varSuffix}";
      $newVar = "new{$varSuffix}";
      //skip it if either is empty or both are exactly the same
      if ($$oldVar &&
        $$newVar &&
        $$oldVar != $$newVar
      ) {
        $from[] = $$oldVar;
        $to[] = $$newVar;
      }
    }

    $sql = "
SELECT config_backend
FROM   civicrm_domain
WHERE  id = %1
";
    $params = array(1 => array(CRM_Core_Config::domainID(), 'Integer'));
    $configBackend = CRM_Core_DAO::singleValueQuery($sql, $params);
    if (!$configBackend) {
      CRM_Core_Error::fatal(ts('Returning early due to unexpected error - civicrm_domain.config_backend column value is NULL. Try visiting CiviCRM Home page.'));
    }
    $configBackend = unserialize($configBackend);

    $configBackend = str_replace($from,
      $to,
      $configBackend
    );

    $configBackend = serialize($configBackend);
    $sql = "
UPDATE civicrm_domain
SET    config_backend = %2
WHERE  id = %1
";
    $params[2] = array($configBackend, 'String');
    CRM_Core_DAO::executeQuery($sql, $params);

    // Apply the changes to civicrm_option_values
    $optionGroups = array('url_preferences', 'directory_preferences');
    foreach ($optionGroups as $option) {
      foreach ($variables as $varSuffix) {
        $oldVar = "old{$varSuffix}";
        $newVar = "new{$varSuffix}";

        $from = $$oldVar;
        $to = $$newVar;

        if ($from && $to && $from != $to) {
          $sql = '
UPDATE civicrm_option_value
SET    value = REPLACE(value, %1, %2)
WHERE  option_group_id = (
  SELECT id
  FROM   civicrm_option_group
  WHERE  name = %3 )
';
Eileen McNaughton's avatar
Eileen McNaughton committed
468 469
          $params = array(
            1 => array($from, 'String'),
totten's avatar
totten committed
470 471 472 473 474 475 476 477
            2 => array($to, 'String'),
            3 => array($option, 'String'),
          );
          CRM_Core_DAO::executeQuery($sql, $params);
        }
      }
    }

Eileen McNaughton's avatar
Eileen McNaughton committed
478 479 480
    $moveStatus .=
      ts('Directory and Resource URLs have been updated in the moved database to reflect current site location.') .
      '<br />';
totten's avatar
totten committed
481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514

    $config = CRM_Core_Config::singleton();

    // clear the template_c and upload directory also
    $config->cleanup(3, TRUE);
    $moveStatus .= ts('Template cache and upload directory have been cleared.') . '<br />';

    // clear all caches
    CRM_Core_Config::clearDBCache();
    $moveStatus .= ts('Database cache tables cleared.') . '<br />';

    $resetSessionTable = CRM_Utils_Request::retrieve('resetSessionTable',
      'Boolean',
      CRM_Core_DAO::$_nullArray,
      FALSE,
      FALSE,
      'REQUEST'
    );
    if ($config->userSystem->is_drupal &&
      $resetSessionTable
    ) {
      db_query("DELETE FROM {sessions} WHERE 1");
      $moveStatus .= ts('Drupal session table cleared.') . '<br />';
    }
    else {
      $session = CRM_Core_Session::singleton();
      $session->reset(2);
      $moveStatus .= ts('Session has been reset.') . '<br />';
    }

    return $moveStatus;
  }

  /**
515
   * Takes a componentName and enables it in the config.
totten's avatar
totten committed
516 517
   * Primarily used during unit testing
   *
518 519
   * @param string $componentName
   *   Name of the component to be enabled, needs to be valid.
totten's avatar
totten committed
520
   *
kurund's avatar
kurund committed
521
   * @return bool
522
   *   true if valid component name and enabling succeeds, else false
totten's avatar
totten committed
523
   */
524
  public static function enableComponent($componentName) {
totten's avatar
totten committed
525 526 527 528 529 530 531
    $config = CRM_Core_Config::singleton();
    if (in_array($componentName, $config->enableComponents)) {
      // component is already enabled
      return TRUE;
    }

    // return if component does not exist
532
    if (!array_key_exists($componentName, CRM_Core_Component::getComponents())) {
totten's avatar
totten committed
533 534 535
      return FALSE;
    }

Deepak Srivastava's avatar
Deepak Srivastava committed
536
    // get enabled-components from DB and add to the list
537
    $enabledComponents = Civi::settings()->get('enable_components');
Deepak Srivastava's avatar
Deepak Srivastava committed
538
    $enabledComponents[] = $componentName;
totten's avatar
totten committed
539

540 541 542 543 544
    self::setEnabledComponents($enabledComponents);

    return TRUE;
  }

Eileen McNaughton's avatar
Eileen McNaughton committed
545 546 547 548 549 550 551
  /**
   * Disable specified component.
   *
   * @param string $componentName
   *
   * @return bool
   */
552
  public static function disableComponent($componentName) {
553
    $config = CRM_Core_Config::singleton();
Eileen McNaughton's avatar
Eileen McNaughton committed
554 555 556
    if (!in_array($componentName, $config->enableComponents) ||
      !array_key_exists($componentName, CRM_Core_Component::getComponents())
    ) {
Eileen McNaughton's avatar
Eileen McNaughton committed
557
      // Post-condition is satisfied.
558 559 560 561
      return TRUE;
    }

    // get enabled-components from DB and add to the list
562
    $enabledComponents = Civi::settings()->get('enable_components');
563 564 565 566 567 568 569
    $enabledComponents = array_diff($enabledComponents, array($componentName));

    self::setEnabledComponents($enabledComponents);

    return TRUE;
  }

Eileen McNaughton's avatar
Eileen McNaughton committed
570 571 572 573 574
  /**
   * Set enabled components.
   *
   * @param array $enabledComponents
   */
575 576
  public static function setEnabledComponents($enabledComponents) {
    $config = CRM_Core_Config::singleton();
totten's avatar
totten committed
577 578

    // fix the config object
Deepak Srivastava's avatar
Deepak Srivastava committed
579
    $config->enableComponents = $enabledComponents;
totten's avatar
totten committed
580 581 582 583

    // also force reset of component array
    CRM_Core_Component::getEnabledComponents(TRUE);

Deepak Srivastava's avatar
Deepak Srivastava committed
584 585
    // update DB
    CRM_Core_BAO_Setting::setItem($enabledComponents,
586
      CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME, 'enable_components');
totten's avatar
totten committed
587 588
  }

589 590 591
  /**
   * @return array
   */
592
  public static function skipVars() {
totten's avatar
totten committed
593
    return array(
Eileen McNaughton's avatar
Eileen McNaughton committed
594 595
      'dsn',
      'templateCompileDir',
totten's avatar
totten committed
596 597
      'userFrameworkDSN',
      'userFramework',
Eileen McNaughton's avatar
Eileen McNaughton committed
598 599 600 601
      'userFrameworkBaseURL',
      'userFrameworkClass',
      'userHookClass',
      'userPermissionClass',
602
      'userPermissionTemp',
Eileen McNaughton's avatar
Eileen McNaughton committed
603 604 605 606 607 608 609 610 611
      'userFrameworkURLVar',
      'userFrameworkVersion',
      'newBaseURL',
      'newBaseDir',
      'newSiteName',
      'configAndLogDir',
      'qfKey',
      'gettextResourceDir',
      'cleanURL',
612
      'entryURL',
Eileen McNaughton's avatar
Eileen McNaughton committed
613 614
      'locale_custom_strings',
      'localeCustomStrings',
totten's avatar
totten committed
615 616 617
      'autocompleteContactSearch',
      'autocompleteContactReference',
      'checksumTimeout',
618
      'checksum_timeout',
totten's avatar
totten committed
619 620
    );
  }
621

622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638
  /**
   * @param array $params
   * @return array
   */
  public static function filterSkipVars($params) {
    $skipVars = self::skipVars();
    foreach ($skipVars as $var) {
      unset($params[$var]);
    }
    foreach (array_keys($params) as $key) {
      if (preg_match('/^_qf_/', $key)) {
        unset($params[$key]);
      }
    }
    return $params;
  }

totten's avatar
totten committed
639
}