wikimedia/mediawiki-core

View on GitHub
includes/installer/SqliteInstaller.php

Summary

Maintainability
C
1 day
Test Coverage

Method setupDatabase has 83 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    public function setupDatabase() {
        $dir = $this->getVar( 'wgSQLiteDataDir' );

        # Double check (Only available in web installation). We checked this before but maybe someone
        # deleted the data dir between then and now
Severity: Major
Found in includes/installer/SqliteInstaller.php - About 3 hrs to fix

    File SqliteInstaller.php has 280 lines of code (exceeds 250 allowed). Consider refactoring.
    Open

    <?php
    
    /**
     * Sqlite-specific installer.
     *
    Severity: Minor
    Found in includes/installer/SqliteInstaller.php - About 2 hrs to fix

      Method getLocalSettings has 39 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          public function getLocalSettings() {
              $dir = LocalSettingsGenerator::escapePhpString( $this->getVar( 'wgSQLiteDataDir' ) );
              // These tables have frequent writes and are thus split off from the main one.
              // Since the code using these tables only uses transactions for writes, then set
              // them to using BEGIN IMMEDIATE. This avoids frequent lock errors on the first write action.
      Severity: Minor
      Found in includes/installer/SqliteInstaller.php - About 1 hr to fix

        Function setupDatabase has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
        Open

            public function setupDatabase() {
                $dir = $this->getVar( 'wgSQLiteDataDir' );
        
                # Double check (Only available in web installation). We checked this before but maybe someone
                # deleted the data dir between then and now
        Severity: Minor
        Found in includes/installer/SqliteInstaller.php - About 35 mins to fix

        Cognitive Complexity

        Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

        A method's cognitive complexity is based on a few simple rules:

        • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
        • Code is considered more complex for each "break in the linear flow of the code"
        • Code is considered more complex when "flow breaking structures are nested"

        Further reading

        Avoid too many return statements within this method.
        Open

                    return Status::newFatal( 'config-sqlite-connection-error', $e->getMessage() );
        Severity: Major
        Found in includes/installer/SqliteInstaller.php - About 30 mins to fix

          Avoid too many return statements within this method.
          Open

                  return $mainConnStatus;
          Severity: Major
          Found in includes/installer/SqliteInstaller.php - About 30 mins to fix

            Function checkDataDir has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
            Open

                public static function checkDataDir( $dir ): Status {
                    if ( is_dir( $dir ) ) {
                        if ( !is_readable( $dir ) ) {
                            return Status::newFatal( 'config-sqlite-dir-unwritable', $dir );
                        }
            Severity: Minor
            Found in includes/installer/SqliteInstaller.php - About 25 mins to fix

            Cognitive Complexity

            Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

            A method's cognitive complexity is based on a few simple rules:

            • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
            • Code is considered more complex for each "break in the linear flow of the code"
            • Code is considered more complex when "flow breaking structures are nested"

            Further reading

            Similar blocks of code found in 2 locations. Consider refactoring.
            Open

                    try {
                        $conn = ( new DatabaseFactory() )->create(
                            'sqlite', [ 'dbname' => "{$db}_jobqueue", 'dbDirectory' => $dir ] );
                        # @todo: don't duplicate job definition, though it's very static
                        $sql =
            Severity: Minor
            Found in includes/installer/SqliteInstaller.php and 1 other location - About 1 hr to fix
            includes/installer/SqliteInstaller.php on lines 232..250

            Duplicated Code

            Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

            Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

            When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

            Tuning

            This issue has a mass of 100.

            We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

            The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

            If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

            See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

            Refactorings

            Further Reading

            Similar blocks of code found in 2 locations. Consider refactoring.
            Open

                    try {
                        $conn = ( new DatabaseFactory() )->create(
                            'sqlite', [ 'dbname' => "{$db}_l10n_cache", 'dbDirectory' => $dir ] );
                        # @todo: don't duplicate l10n_cache definition, though it's very simple
                        $sql =
            Severity: Minor
            Found in includes/installer/SqliteInstaller.php and 1 other location - About 1 hr to fix
            includes/installer/SqliteInstaller.php on lines 253..283

            Duplicated Code

            Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

            Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

            When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

            Tuning

            This issue has a mass of 100.

            We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

            The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

            If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

            See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

            Refactorings

            Further Reading

            There are no issues that match your filters.

            Category
            Status