wikimedia/mediawiki-core

View on GitHub
includes/libs/filebackend/FileBackendMultiWrite.php

Summary

Maintainability
F
5 days
Test Coverage

File FileBackendMultiWrite.php has 530 lines of code (exceeds 250 allowed). Consider refactoring.
Open

<?php
/**
 * Proxy backend that mirrors writes to several internal backends.
 *
 * This program is free software; you can redistribute it and/or modify
Severity: Major
Found in includes/libs/filebackend/FileBackendMultiWrite.php - About 1 day to fix

    Function resyncFiles has a Cognitive Complexity of 38 (exceeds 5 allowed). Consider refactoring.
    Open

        public function resyncFiles( array $paths, $resyncMode = true ) {
            $status = $this->newStatus();
    
            $fname = __METHOD__;
            foreach ( $paths as $path ) {
    Severity: Minor
    Found in includes/libs/filebackend/FileBackendMultiWrite.php - About 5 hrs 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

    Function consistencyCheck has a Cognitive Complexity of 36 (exceeds 5 allowed). Consider refactoring.
    Open

        public function consistencyCheck( array $paths ) {
            $status = $this->newStatus();
            if ( $this->syncChecks == 0 || count( $this->backends ) <= 1 ) {
                return $status; // skip checks
            }
    Severity: Minor
    Found in includes/libs/filebackend/FileBackendMultiWrite.php - About 5 hrs 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

    FileBackendMultiWrite has 40 functions (exceeds 20 allowed). Consider refactoring.
    Open

    class FileBackendMultiWrite extends FileBackend {
        /** @var FileBackendStore[] Prioritized list of FileBackendStore objects */
        protected $backends = [];
    
        /** @var int Index of master backend */
    Severity: Minor
    Found in includes/libs/filebackend/FileBackendMultiWrite.php - About 5 hrs to fix

      Function doOperationsInternal has a Cognitive Complexity of 20 (exceeds 5 allowed). Consider refactoring.
      Open

          final protected function doOperationsInternal( array $ops, array $opts ) {
              $status = $this->newStatus();
      
              $fname = __METHOD__;
              $mbe = $this->backends[$this->masterIndex]; // convenience
      Severity: Minor
      Found in includes/libs/filebackend/FileBackendMultiWrite.php - About 2 hrs 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

      Method resyncFiles has 67 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          public function resyncFiles( array $paths, $resyncMode = true ) {
              $status = $this->newStatus();
      
              $fname = __METHOD__;
              foreach ( $paths as $path ) {
      Severity: Major
      Found in includes/libs/filebackend/FileBackendMultiWrite.php - About 2 hrs to fix

        Method doOperationsInternal has 64 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

            final protected function doOperationsInternal( array $ops, array $opts ) {
                $status = $this->newStatus();
        
                $fname = __METHOD__;
                $mbe = $this->backends[$this->masterIndex]; // convenience
        Severity: Major
        Found in includes/libs/filebackend/FileBackendMultiWrite.php - About 2 hrs to fix

          Method consistencyCheck has 62 lines of code (exceeds 25 allowed). Consider refactoring.
          Open

              public function consistencyCheck( array $paths ) {
                  $status = $this->newStatus();
                  if ( $this->syncChecks == 0 || count( $this->backends ) <= 1 ) {
                      return $status; // skip checks
                  }
          Severity: Major
          Found in includes/libs/filebackend/FileBackendMultiWrite.php - About 2 hrs to fix

            Function __construct has a Cognitive Complexity of 15 (exceeds 5 allowed). Consider refactoring.
            Open

                public function __construct( array $config ) {
                    parent::__construct( $config );
                    $this->syncChecks = $config['syncChecks'] ?? self::CHECK_SIZE;
                    $this->autoResync = $config['autoResync'] ?? false;
                    $this->asyncWrites = isset( $config['replication'] ) && $config['replication'] === 'async';
            Severity: Minor
            Found in includes/libs/filebackend/FileBackendMultiWrite.php - About 1 hr 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

            Method __construct has 36 lines of code (exceeds 25 allowed). Consider refactoring.
            Open

                public function __construct( array $config ) {
                    parent::__construct( $config );
                    $this->syncChecks = $config['syncChecks'] ?? self::CHECK_SIZE;
                    $this->autoResync = $config['autoResync'] ?? false;
                    $this->asyncWrites = isset( $config['replication'] ) && $config['replication'] === 'async';
            Severity: Minor
            Found in includes/libs/filebackend/FileBackendMultiWrite.php - About 1 hr to fix

              Function fileStoragePathsForOps has a Cognitive Complexity of 11 (exceeds 5 allowed). Consider refactoring.
              Open

                  protected function fileStoragePathsForOps( array $ops ) {
                      $paths = [];
                      foreach ( $ops as $op ) {
                          if ( isset( $op['src'] ) ) {
                              // For things like copy/move/delete with "ignoreMissingSource" and there
              Severity: Minor
              Found in includes/libs/filebackend/FileBackendMultiWrite.php - About 1 hr 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

              Function doQuickOperationsInternal has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
              Open

                  protected function doQuickOperationsInternal( array $ops, array $opts ) {
                      $status = $this->newStatus();
                      // Do the operations on the master backend; setting StatusValue fields
                      $realOps = $this->substOpBatchPaths( $ops, $this->backends[$this->masterIndex] );
                      $masterStatus = $this->backends[$this->masterIndex]->doQuickOperations( $realOps );
              Severity: Minor
              Found in includes/libs/filebackend/FileBackendMultiWrite.php - About 45 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

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

                  public function accessibilityCheck( array $paths ) {
                      $status = $this->newStatus();
                      if ( count( $this->backends ) <= 1 ) {
                          return $status; // skip checks
                      }
              Severity: Minor
              Found in includes/libs/filebackend/FileBackendMultiWrite.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

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

                  protected function doDirectoryOp( $method, array $params ) {
                      $status = $this->newStatus();
              
                      $realParams = $this->substOpPaths( $params, $this->backends[$this->masterIndex] );
                      $masterStatus = $this->backends[$this->masterIndex]->$method( $realParams );
              Severity: Minor
              Found in includes/libs/filebackend/FileBackendMultiWrite.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

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

                  private function getFileListForWrite( $params ) {
                      $files = [];
                      // Get the list of thumbnails from all backends to allow
                      // deleting all of them. Otherwise, old thumbnails existing on
                      // one backend only won't get updated in reupload (T331138).
              Severity: Minor
              Found in includes/libs/filebackend/FileBackendMultiWrite.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

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

                  protected function substOpBatchPaths( array $ops, FileBackendStore $backend ) {
                      $newOps = []; // operations
                      foreach ( $ops as $op ) {
                          $newOp = $op; // operation
                          foreach ( [ 'src', 'srcs', 'dst', 'dir' ] as $par ) {
              Severity: Minor
              Found in includes/libs/filebackend/FileBackendMultiWrite.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 3 locations. Consider refactoring.
              Open

                  public function getFileContentsMulti( array $params ) {
                      $index = $this->getReadIndexFromParams( $params );
                      $realParams = $this->substOpPaths( $params, $this->backends[$index] );
              
                      $contentsM = $this->backends[$index]->getFileContentsMulti( $realParams );
              Severity: Major
              Found in includes/libs/filebackend/FileBackendMultiWrite.php and 2 other locations - About 1 hr to fix
              includes/libs/filebackend/FileBackendMultiWrite.php on lines 711..723
              includes/libs/filebackend/FileBackendMultiWrite.php on lines 725..737

              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 107.

              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 3 locations. Consider refactoring.
              Open

                  public function getLocalCopyMulti( array $params ) {
                      $index = $this->getReadIndexFromParams( $params );
                      $realParams = $this->substOpPaths( $params, $this->backends[$index] );
              
                      $tempFilesM = $this->backends[$index]->getLocalCopyMulti( $realParams );
              Severity: Major
              Found in includes/libs/filebackend/FileBackendMultiWrite.php and 2 other locations - About 1 hr to fix
              includes/libs/filebackend/FileBackendMultiWrite.php on lines 676..688
              includes/libs/filebackend/FileBackendMultiWrite.php on lines 711..723

              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 107.

              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 3 locations. Consider refactoring.
              Open

                  public function getLocalReferenceMulti( array $params ) {
                      $index = $this->getReadIndexFromParams( $params );
                      $realParams = $this->substOpPaths( $params, $this->backends[$index] );
              
                      $fsFilesM = $this->backends[$index]->getLocalReferenceMulti( $realParams );
              Severity: Major
              Found in includes/libs/filebackend/FileBackendMultiWrite.php and 2 other locations - About 1 hr to fix
              includes/libs/filebackend/FileBackendMultiWrite.php on lines 676..688
              includes/libs/filebackend/FileBackendMultiWrite.php on lines 725..737

              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 107.

              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