wikimedia/mediawiki-core

View on GitHub
includes/filerepo/file/ArchivedFile.php

Summary

Maintainability
F
4 days
Test Coverage

File ArchivedFile.php has 393 lines of code (exceeds 250 allowed). Consider refactoring.
Open

<?php
/**
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
Severity: Minor
Found in includes/filerepo/file/ArchivedFile.php - About 5 hrs to fix

    ArchivedFile has 34 functions (exceeds 20 allowed). Consider refactoring.
    Open

    class ArchivedFile {
    
        // Audience options for ::getDescription() and ::getUploader()
        public const FOR_PUBLIC = 1;
        public const FOR_THIS_USER = 2;
    Severity: Minor
    Found in includes/filerepo/file/ArchivedFile.php - About 4 hrs to fix

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

          protected function loadMetadataFromString( $metadataString ) {
              $this->extraDataLoaded = true;
              $this->metadataArray = [];
              $this->metadataBlobs = [];
              $this->unloadedMetadataBlobs = [];
      Severity: Minor
      Found in includes/filerepo/file/ArchivedFile.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( $title, $id = 0, $key = '', $sha1 = '' ) {
              $this->id = -1;
              $this->title = null;
              $this->name = false;
              $this->group = 'deleted'; // needed for direct use of constructor
      Severity: Minor
      Found in includes/filerepo/file/ArchivedFile.php - About 1 hr to fix

        Method load has 35 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

            public function load() {
                if ( $this->dataLoaded ) {
                    return true;
                }
                $conds = [];
        Severity: Minor
        Found in includes/filerepo/file/ArchivedFile.php - About 1 hr to fix

          Method loadMetadataFromString has 33 lines of code (exceeds 25 allowed). Consider refactoring.
          Open

              protected function loadMetadataFromString( $metadataString ) {
                  $this->extraDataLoaded = true;
                  $this->metadataArray = [];
                  $this->metadataBlobs = [];
                  $this->unloadedMetadataBlobs = [];
          Severity: Minor
          Found in includes/filerepo/file/ArchivedFile.php - About 1 hr to fix

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

                public function load() {
                    if ( $this->dataLoaded ) {
                        return true;
                    }
                    $conds = [];
            Severity: Minor
            Found in includes/filerepo/file/ArchivedFile.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 loadFromRow has 29 lines of code (exceeds 25 allowed). Consider refactoring.
            Open

                public function loadFromRow( $row ) {
                    $this->id = intval( $row->fa_id );
                    $this->name = $row->fa_name;
                    $this->archive_name = $row->fa_archive_name;
                    $this->group = $row->fa_storage_group;
            Severity: Minor
            Found in includes/filerepo/file/ArchivedFile.php - About 1 hr to fix

              Function getMetadataItems has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
              Open

                  public function getMetadataItems( array $itemNames ): array {
                      $this->load();
                      $result = [];
                      $addresses = [];
                      foreach ( $itemNames as $itemName ) {
              Severity: Minor
              Found in includes/filerepo/file/ArchivedFile.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 __construct has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
              Open

                  public function __construct( $title, $id = 0, $key = '', $sha1 = '' ) {
                      $this->id = -1;
                      $this->title = null;
                      $this->name = false;
                      $this->group = 'deleted'; // needed for direct use of constructor
              Severity: Minor
              Found in includes/filerepo/file/ArchivedFile.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

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

                  protected function loadMetadataFromString( $metadataString ) {
                      $this->extraDataLoaded = true;
                      $this->metadataArray = [];
                      $this->metadataBlobs = [];
                      $this->unloadedMetadataBlobs = [];
              Severity: Major
              Found in includes/filerepo/file/ArchivedFile.php and 1 other location - About 1 day to fix
              includes/filerepo/file/LocalFile.php on lines 1146..1183

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

              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

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

                  public function getUploader( int $audience = self::FOR_PUBLIC, Authority $performer = null ): ?UserIdentity {
                      $this->load();
                      if ( $audience === self::FOR_PUBLIC && $this->isDeleted( File::DELETED_USER ) ) {
                          return null;
                      } elseif ( $audience === self::FOR_THIS_USER && !$this->userCan( File::DELETED_USER, $performer ) ) {
              Severity: Major
              Found in includes/filerepo/file/ArchivedFile.php and 1 other location - About 1 hr to fix
              includes/filerepo/file/LocalFile.php on lines 2420..2429

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

              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

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

                      if ( $addresses ) {
                          $resultFromBlob = $this->metadataStorageHelper->getMetadataFromBlobStore( $addresses );
                          foreach ( $addresses as $itemName => $address ) {
                              unset( $this->unloadedMetadataBlobs[$itemName] );
                              $value = $resultFromBlob[$itemName] ?? null;
              Severity: Minor
              Found in includes/filerepo/file/ArchivedFile.php and 1 other location - About 30 mins to fix
              includes/filerepo/file/LocalFile.php on lines 1042..1052

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

              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