Standardize mysql.configuration-provider

Summary: NOTE: BC break!

Test Plan: /

Reviewers: epriestley

Reviewed By: epriestley

CC: aran, nh

Differential Revision: https://secure.phabricator.com/D2130

conf/default.conf.php

@@ -106,6 +106,10 @@ return array(
 
 // --  MySQL  --------------------------------------------------------------- //
 
+  // Class providing database configuration. It must implement
+  // DatabaseConfigurationProvider.
+  'mysql.configuration-provider' => 'DefaultDatabaseConfigurationProvider',
+
   // The username to use when connecting to MySQL.
   'mysql.user' => 'root',
 

scripts/sql/upgrade_schema.php

@@ -61,7 +61,7 @@ if (empty($options['f']) && empty($options['d'])) {
 $next_version = isset($options['v']) ? (int)$options['v'] : null;
 $max_version = isset($options['m']) ? (int)$options['m'] : null;
 
-$conf = DatabaseConfigurationProvider::getConfiguration();
+$conf = PhabricatorEnv::newObjectFromConfig('mysql.configuration-provider');
 
 if ($options['u']) {
   $conn_user = $options['u'];

src/__phutil_library_map__.php

@@ -190,7 +190,8 @@ phutil_register_library_map(array(
     'DarkConsoleServicesPlugin' => 'aphront/console/plugin/services',
     'DarkConsoleXHProfPlugin' => 'aphront/console/plugin/xhprof',
     'DarkConsoleXHProfPluginAPI' => 'aphront/console/plugin/xhprof/api',
-    'DatabaseConfigurationProvider' => 'applications/base/storage/configuration',
+    'DatabaseConfigurationProvider' => 'applications/base/storage/configuration/base',
+    'DefaultDatabaseConfigurationProvider' => 'applications/base/storage/configuration/default',
     'DifferentialAction' => 'applications/differential/constants/action',
     'DifferentialActionHasNoEffectException' => 'applications/differential/exception/noeffect',
     'DifferentialAddCommentView' => 'applications/differential/view/addcomment',
@@ -1134,6 +1135,7 @@ phutil_register_library_map(array(
     'DarkConsoleRequestPlugin' => 'DarkConsolePlugin',
     'DarkConsoleServicesPlugin' => 'DarkConsolePlugin',
     'DarkConsoleXHProfPlugin' => 'DarkConsolePlugin',
+    'DefaultDatabaseConfigurationProvider' => 'DatabaseConfigurationProvider',
     'DifferentialActionHasNoEffectException' => 'DifferentialException',
     'DifferentialAddCommentView' => 'AphrontView',
     'DifferentialAffectedPath' => 'DifferentialDAO',

src/applications/base/storage/configuration/__init__.php

@@ -1,16 +0,0 @@
-<?php
-/**
- * This file is automatically generated. Lint this module to rebuild it.
- * @generated
- */
-
-
-
-phutil_require_module('phabricator', 'applications/people/storage/user');
-phutil_require_module('phabricator', 'infrastructure/env');
-
-phutil_require_module('phutil', 'symbols');
-phutil_require_module('phutil', 'utils');
-
-
-phutil_require_source('DatabaseConfigurationProvider.php');

src/applications/base/storage/configuration/base/DatabaseConfigurationProvider.php

@@ -0,0 +1,30 @@
+<?php
+
+/*
+ * Copyright 2012 Facebook, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * @stable
+ */
+interface DatabaseConfigurationProvider {
+
+  public function __construct(LiskDAO $dao = null, $mode = 'r');
+  public function getUser();
+  public function getPassword();
+  public function getHost();
+  public function getDatabase();
+
+}

src/applications/base/storage/configuration/base/__init__.php

@@ -0,0 +1,10 @@
+<?php
+/**
+ * This file is automatically generated. Lint this module to rebuild it.
+ * @generated
+ */
+
+
+
+
+phutil_require_source('DatabaseConfigurationProvider.php');

src/applications/base/storage/configuration/default/DefaultDatabaseConfigurationProvider.php

@@ -16,14 +16,13 @@
  * limitations under the License.
  */
 
-/**
- * TODO: Can we final this?
- */
-class DatabaseConfigurationProvider {
+final class DefaultDatabaseConfigurationProvider
+  implements DatabaseConfigurationProvider {
+
   private $dao;
   private $mode;
 
-  public function __construct(LiskDAO $dao, $mode) {
+  public function __construct(LiskDAO $dao = null, $mode = 'r') {
     $this->dao = $dao;
     $this->mode = $mode;
   }
@@ -41,6 +40,9 @@ class DatabaseConfigurationProvider {
   }
 
   public function getDatabase() {
+    if (!$this->getDao()) {
+      return null;
+    }
     return 'phabricator_'.$this->getDao()->getApplicationName();
   }
 
@@ -48,18 +50,4 @@ class DatabaseConfigurationProvider {
     return $this->dao;
   }
 
-  final protected function getMode() {
-    return $this->mode;
-  }
-
-  public static function getConfiguration() {
-    // Get DB info. Note that we are using a dummy PhabricatorUser object in
-    // creating the DatabaseConfigurationProvider, which is not used at all.
-    $conf_provider = PhabricatorEnv::getEnvConfig(
-      'mysql.configuration_provider', 'DatabaseConfigurationProvider');
-    PhutilSymbolLoader::loadClass($conf_provider);
-    $conf = newv($conf_provider, array(new PhabricatorUser(), 'r'));
-    return $conf;
-  }
-
 }

src/applications/base/storage/configuration/default/__init__.php

@@ -0,0 +1,13 @@
+<?php
+/**
+ * This file is automatically generated. Lint this module to rebuild it.
+ * @generated
+ */
+
+
+
+phutil_require_module('phabricator', 'applications/base/storage/configuration/base');
+phutil_require_module('phabricator', 'infrastructure/env');
+
+
+phutil_require_source('DefaultDatabaseConfigurationProvider.php');

src/applications/base/storage/lisk/PhabricatorLiskDAO.php

@@ -66,10 +66,9 @@ abstract class PhabricatorLiskDAO extends LiskDAO {
    * @task config
    */
   public function establishLiveConnection($mode) {
-    $conf_provider = PhabricatorEnv::getEnvConfig(
-      'mysql.configuration_provider', 'DatabaseConfigurationProvider');
-    PhutilSymbolLoader::loadClass($conf_provider);
-    $conf = newv($conf_provider, array($this, $mode));
+    $conf = PhabricatorEnv::newObjectFromConfig(
+      'mysql.configuration-provider',
+      array($this, $mode));
 
     return PhabricatorEnv::newObjectFromConfig(
       'mysql.implementation',

src/applications/base/storage/lisk/__init__.php

@@ -9,7 +9,6 @@
 phutil_require_module('phabricator', 'infrastructure/env');
 phutil_require_module('phabricator', 'storage/lisk/dao');
 
-phutil_require_module('phutil', 'symbols');
 phutil_require_module('phutil', 'utils');
 
 

src/infrastructure/env/PhabricatorEnv.php

@@ -57,6 +57,7 @@ final class PhabricatorEnv {
         'PhabricatorOAuthRegistrationController',
       'mysql.implementation' => 'AphrontMySQLDatabaseConnectionBase',
       'differential.attach-task-class' => 'DifferentialTasksAttacher',
+      'mysql.configuration-provider' => 'DatabaseConfigurationProvider',
     );
   }
 

src/infrastructure/setup/PhabricatorSetup.php

@@ -455,7 +455,7 @@ final class PhabricatorSetup {
 
     self::writeHeader("MySQL DATABASE & STORAGE CONFIGURATION");
 
-    $conf = DatabaseConfigurationProvider::getConfiguration();
+    $conf = PhabricatorEnv::newObjectFromConfig('mysql.configuration-provider');
     $conn_user = $conf->getUser();
     $conn_pass = $conf->getPassword();
     $conn_host = $conf->getHost();

src/infrastructure/setup/__init__.php

@@ -6,7 +6,6 @@
 
 
 
-phutil_require_module('phabricator', 'applications/base/storage/configuration');
 phutil_require_module('phabricator', 'infrastructure/env');
 phutil_require_module('phabricator', 'infrastructure/setup/sql');
 phutil_require_module('phabricator', 'storage/queryfx');