wikimedia/mediawiki-core

View on GitHub
includes/api/ApiQueryRevisions.php

Summary

Maintainability
F
6 days
Test Coverage

Function run has a Cognitive Complexity of 113 (exceeds 5 allowed). Consider refactoring.
Open

    protected function run( ApiPageSet $resultPageSet = null ) {
        $params = $this->extractRequestParams( false );

        // If any of those parameters are used, work in 'enumeration' mode.
        // Enum mode can only be used when exactly one page is provided.
Severity: Minor
Found in includes/api/ApiQueryRevisions.php - About 2 days 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 run has 267 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    protected function run( ApiPageSet $resultPageSet = null ) {
        $params = $this->extractRequestParams( false );

        // If any of those parameters are used, work in 'enumeration' mode.
        // Enum mode can only be used when exactly one page is provided.
Severity: Major
Found in includes/api/ApiQueryRevisions.php - About 1 day to fix

    File ApiQueryRevisions.php has 402 lines of code (exceeds 250 allowed). Consider refactoring.
    Open

    <?php
    /**
     * Copyright © 2006 Yuri Astrakhan "<Firstname><Lastname>@gmail.com"
     *
     * This program is free software; you can redistribute it and/or modify
    Severity: Minor
    Found in includes/api/ApiQueryRevisions.php - About 5 hrs to fix

      Method getAllowedParams has 49 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          public function getAllowedParams() {
              $ret = parent::getAllowedParams() + [
                  'startid' => [
                      ParamValidator::PARAM_TYPE => 'integer',
                      ApiBase::PARAM_HELP_MSG_INFO => [ [ 'singlepageonly' ] ],
      Severity: Minor
      Found in includes/api/ApiQueryRevisions.php - About 1 hr to fix

        Method __construct has 13 arguments (exceeds 4 allowed). Consider refactoring.
        Open

                ApiQuery $query,
                $moduleName,
                RevisionStore $revisionStore,
                IContentHandlerFactory $contentHandlerFactory,
                ParserFactory $parserFactory,
        Severity: Major
        Found in includes/api/ApiQueryRevisions.php - About 1 hr to fix

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

              public function __construct(
                  ApiQuery $query,
                  $moduleName,
                  RevisionStore $revisionStore,
                  IContentHandlerFactory $contentHandlerFactory,
          Severity: Major
          Found in includes/api/ApiQueryRevisions.php and 3 other locations - About 4 hrs to fix
          includes/api/ApiQueryAllDeletedRevisions.php on lines 69..101
          includes/api/ApiQueryAllRevisions.php on lines 66..98
          includes/api/ApiQueryDeletedRevisions.php on lines 68..100

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

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

                      if ( $params['user'] !== null || $params['excludeuser'] !== null ) {
                          // Paranoia: avoid brute force searches (T19342)
                          if ( !$this->getAuthority()->isAllowed( 'deletedhistory' ) ) {
                              $bitmask = RevisionRecord::DELETED_USER;
                          } elseif ( !$this->getAuthority()->isAllowedAny( 'suppressrevision', 'viewsuppressed' ) ) {
          Severity: Major
          Found in includes/api/ApiQueryRevisions.php and 4 other locations - About 2 hrs to fix
          includes/api/ApiQueryAllDeletedRevisions.php on lines 295..307
          includes/api/ApiQueryAllRevisions.php on lines 178..190
          includes/api/ApiQueryDeletedRevisions.php on lines 188..200
          includes/api/ApiQueryDeletedrevs.php on lines 237..251

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

          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

                          if ( $params['end'] !== null ) {
                              $op = ( $params['dir'] === 'newer' ? '<=' : '>=' ); // Yes, opposite of the above
                              // @phan-suppress-next-line PhanTypePossiblyInvalidDimOffset False positive
                              $ts = $db->timestampOrNull( $params['end'] );
                              if ( $params['endid'] !== null ) {
          Severity: Major
          Found in includes/api/ApiQueryRevisions.php and 1 other location - About 2 hrs to fix
          includes/api/ApiQueryRevisions.php on lines 284..296

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

          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

                          if ( $params['start'] !== null ) {
                              $op = ( $params['dir'] === 'newer' ? '>=' : '<=' );
                              // @phan-suppress-next-line PhanTypePossiblyInvalidDimOffset False positive
                              $ts = $db->timestampOrNull( $params['start'] );
                              if ( $params['startid'] !== null ) {
          Severity: Major
          Found in includes/api/ApiQueryRevisions.php and 1 other location - About 2 hrs to fix
          includes/api/ApiQueryRevisions.php on lines 298..310

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

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

                  if ( $params['tag'] !== null ) {
                      $this->addTables( 'change_tag' );
                      $this->addJoinConds(
                          [ 'change_tag' => [ 'JOIN', [ 'rev_id=ct_rev_id' ] ] ]
                      );
          Severity: Major
          Found in includes/api/ApiQueryRevisions.php and 5 other locations - About 40 mins to fix
          includes/api/ApiQueryAllDeletedRevisions.php on lines 192..203
          includes/api/ApiQueryDeletedRevisions.php on lines 139..150
          includes/api/ApiQueryDeletedrevs.php on lines 155..166
          includes/api/ApiQueryLogEvents.php on lines 148..158
          includes/api/ApiQueryRecentChanges.php on lines 318..327

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

          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