includes/ExtensionInfo.php

   1 <?php
   2
   3 namespace MediaWiki;
   4
   5 /**
   6  * @since 1.35
   7  */
   8 class ExtensionInfo {
   9
  10         /**
  11          * Obtains the full path of a AUTHORS or CREDITS file if one exists.
  12          *
  13          * @param string $dir Path to the root directory
  14          *
  15          * @since 1.35
  16          *
  17          * @return bool|string False if no such file exists, otherwise returns
  18          * a path to it.
  19          */
  20         public static function getAuthorsFileName( $dir ) {
  21                 if ( !$dir ) {
  22                         return false;
  23                 }
  24
  25                 foreach ( scandir( $dir ) as $file ) {
  26                         $fullPath = $dir . DIRECTORY_SEPARATOR . $file;
  27                         if ( preg_match( '/^(AUTHORS|CREDITS)(\.txt|\.wiki|\.mediawiki)?$/', $file ) &&
  28                                 is_readable( $fullPath ) &&
  29                                 is_file( $fullPath )
  30                         ) {
  31                                 return $fullPath;
  32                         }
  33                 }
  34
  35                 return false;
  36         }
  37
  38         /**
  39          * Obtains the full paths of COPYING or LICENSE files if they exist.
  40          *
  41          * @param string $extDir Path to the extensions root directory
  42          *
  43          * @since 1.35
  44          *
  45          * @return string[] Returns an array of zero or more paths.
  46          */
  47         public static function getLicenseFileNames( $extDir ) {
  48                 if ( !$extDir ) {
  49                         return [];
  50                 }
  51
  52                 $licenseFiles = [];
  53                 foreach ( scandir( $extDir ) as $file ) {
  54                         $fullPath = $extDir . DIRECTORY_SEPARATOR . $file;
  55                         // Allow files like GPL-COPYING and MIT-LICENSE
  56                         if ( preg_match( '/^([\w\.-]+)?(COPYING|LICENSE)(\.txt)?$/', $file ) &&
  57                                 is_readable( $fullPath ) &&
  58                                 is_file( $fullPath )
  59                         ) {
  60                                 $licenseFiles[] = $fullPath;
  61                         }
  62                 }
  63
  64                 return $licenseFiles;
  65         }
  66 }