wikimedia/mediawiki-core

View on GitHub
includes/media/Exif.php

Summary

Maintainability
F
6 days
Test Coverage

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

    public function __construct( $file, $byteOrder = '' ) {
        /**
         * Page numbers here refer to pages in the Exif 2.2 standard
         *
         * Note, Exif::UNDEFINED is treated as a string, not as an array of bytes
Severity: Major
Found in includes/media/Exif.php - About 1 day to fix

    File Exif.php has 633 lines of code (exceeds 250 allowed). Consider refactoring.
    Open

    <?php
    /**
     * Extraction and validation of image metadata.
     *
     * This program is free software; you can redistribute it and/or modify
    Severity: Major
    Found in includes/media/Exif.php - About 1 day to fix

      Function collapseData has a Cognitive Complexity of 22 (exceeds 5 allowed). Consider refactoring.
      Open

          private function collapseData() {
              $this->exifGPStoNumber( 'GPSLatitude' );
              $this->exifGPStoNumber( 'GPSDestLatitude' );
              $this->exifGPStoNumber( 'GPSLongitude' );
              $this->exifGPStoNumber( 'GPSDestLongitude' );
      Severity: Minor
      Found in includes/media/Exif.php - About 3 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 validate has 63 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          private function validate( $section, $tag, $val, $recursive = false ): bool {
              $debug = "tag is '$tag'";
              $etype = $this->mExifTags[$section][$tag];
              $ecount = 1;
              if ( is_array( $etype ) ) {
      Severity: Major
      Found in includes/media/Exif.php - About 2 hrs to fix

        Method collapseData has 57 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

            private function collapseData() {
                $this->exifGPStoNumber( 'GPSLatitude' );
                $this->exifGPStoNumber( 'GPSDestLatitude' );
                $this->exifGPStoNumber( 'GPSLongitude' );
                $this->exifGPStoNumber( 'GPSDestLongitude' );
        Severity: Major
        Found in includes/media/Exif.php - About 2 hrs to fix

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

              private function charCodeString( $prop ) {
                  if ( isset( $this->mFilteredExifData[$prop] ) ) {
                      if ( strlen( $this->mFilteredExifData[$prop] ) <= 8 ) {
                          // invalid. Must be at least 9 bytes long.
          
          
          Severity: Minor
          Found in includes/media/Exif.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 validate has a Cognitive Complexity of 15 (exceeds 5 allowed). Consider refactoring.
          Open

              private function validate( $section, $tag, $val, $recursive = false ): bool {
                  $debug = "tag is '$tag'";
                  $etype = $this->mExifTags[$section][$tag];
                  $ecount = 1;
                  if ( is_array( $etype ) ) {
          Severity: Minor
          Found in includes/media/Exif.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 makeFilteredData has a Cognitive Complexity of 14 (exceeds 5 allowed). Consider refactoring.
          Open

              private function makeFilteredData() {
                  $this->mFilteredExifData = [];
          
                  foreach ( $this->mRawExifData as $section => $data ) {
                      if ( !array_key_exists( $section, $this->mExifTags ) ) {
          Severity: Minor
          Found in includes/media/Exif.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 charCodeString has 40 lines of code (exceeds 25 allowed). Consider refactoring.
          Open

              private function charCodeString( $prop ) {
                  if ( isset( $this->mFilteredExifData[$prop] ) ) {
                      if ( strlen( $this->mFilteredExifData[$prop] ) <= 8 ) {
                          // invalid. Must be at least 9 bytes long.
          
          
          Severity: Minor
          Found in includes/media/Exif.php - About 1 hr to fix

            Consider simplifying this complex logical expression.
            Open

                    if ( isset( $loc ) && isset( $dir )
                        && ( $dir === 'N' || $dir === 'S' || $dir === 'E' || $dir === 'W' )
                    ) {
                        [ $num, $denom ] = explode( '/', $loc[0], 2 );
                        $res = (int)$num / (int)$denom;
            Severity: Major
            Found in includes/media/Exif.php - About 40 mins to fix

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

                  private function exifGPStoNumber( $prop ) {
                      $loc =& $this->mFilteredExifData[$prop];
                      $dir =& $this->mFilteredExifData[$prop . 'Ref'];
                      $res = false;
              
              
              Severity: Minor
              Found in includes/media/Exif.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 $this->isLong( $val );
              Severity: Major
              Found in includes/media/Exif.php - About 30 mins to fix

                Avoid too many return statements within this method.
                Open

                                return $this->isSlong( $val );
                Severity: Major
                Found in includes/media/Exif.php - About 30 mins to fix

                  Avoid too many return statements within this method.
                  Open

                                  return $this->isRational( $val );
                  Severity: Major
                  Found in includes/media/Exif.php - About 30 mins to fix

                    Avoid too many return statements within this method.
                    Open

                                    return $this->isASCII( $val );
                    Severity: Major
                    Found in includes/media/Exif.php - About 30 mins to fix

                      Avoid too many return statements within this method.
                      Open

                                      return $this->isByte( $val );
                      Severity: Major
                      Found in includes/media/Exif.php - About 30 mins to fix

                        Avoid too many return statements within this method.
                        Open

                                        return $this->isUndefined( $val );
                        Severity: Major
                        Found in includes/media/Exif.php - About 30 mins to fix

                          Avoid too many return statements within this method.
                          Open

                                          return false;
                          Severity: Major
                          Found in includes/media/Exif.php - About 30 mins to fix

                            Avoid too many return statements within this method.
                            Open

                                            return false;
                            Severity: Major
                            Found in includes/media/Exif.php - About 30 mins to fix

                              Avoid too many return statements within this method.
                              Open

                                              return $this->isShort( $val );
                              Severity: Major
                              Found in includes/media/Exif.php - About 30 mins to fix

                                Avoid too many return statements within this method.
                                Open

                                                return $this->isShort( $val ) || $this->isLong( $val );
                                Severity: Major
                                Found in includes/media/Exif.php - About 30 mins to fix

                                  Avoid too many return statements within this method.
                                  Open

                                                  return $this->isSrational( $val );
                                  Severity: Major
                                  Found in includes/media/Exif.php - About 30 mins to fix

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

                                        private function debug( $in, $fname, $action = null ) {
                                            if ( !$this->log ) {
                                                return;
                                            }
                                            $type = gettype( $in );
                                    Severity: Minor
                                    Found in includes/media/Exif.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

                                        private function isShort( $in ) {
                                            if ( !is_array( $in ) && sprintf( '%d', $in ) == $in && $in >= 0 && $in <= 65536 ) {
                                                $this->debug( $in, __FUNCTION__, true );
                                    
                                                return true;
                                    Severity: Major
                                    Found in includes/media/Exif.php and 2 other locations - About 1 hr to fix
                                    includes/media/Exif.php on lines 716..726
                                    includes/media/Exif.php on lines 772..782

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

                                    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

                                        private function isByte( $in ) {
                                            if ( !is_array( $in ) && sprintf( '%d', $in ) == $in && $in >= 0 && $in <= 255 ) {
                                                $this->debug( $in, __FUNCTION__, true );
                                    
                                                return true;
                                    Severity: Major
                                    Found in includes/media/Exif.php and 2 other locations - About 1 hr to fix
                                    includes/media/Exif.php on lines 756..766
                                    includes/media/Exif.php on lines 772..782

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

                                    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

                                        private function isLong( $in ) {
                                            if ( !is_array( $in ) && sprintf( '%d', $in ) == $in && $in >= 0 && $in <= 4_294_967_296 ) {
                                                $this->debug( $in, __FUNCTION__, true );
                                    
                                                return true;
                                    Severity: Major
                                    Found in includes/media/Exif.php and 2 other locations - About 1 hr to fix
                                    includes/media/Exif.php on lines 716..726
                                    includes/media/Exif.php on lines 756..766

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

                                    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

                                        private function isRational( $in ) {
                                            $m = [];
                                    
                                            # Avoid division by zero
                                            if ( !is_array( $in )
                                    Severity: Minor
                                    Found in includes/media/Exif.php and 1 other location - About 45 mins to fix
                                    includes/media/Exif.php on lines 833..846

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

                                    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

                                        private function isSrational( $in ) {
                                            $m = [];
                                    
                                            # Avoid division by zero
                                            if ( !is_array( $in ) &&
                                    Severity: Minor
                                    Found in includes/media/Exif.php and 1 other location - About 45 mins to fix
                                    includes/media/Exif.php on lines 788..801

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

                                    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