basedir, '\.ini$', true, true); // Iterate through all the ini files foreach ($files as $file) { /* Language file format is either tag.extension.ini or tag.extension.sys.ini (where "tag" is a language code, e.g. en-GB, and "extension" is the extension element name, e.g. com_content) Joomla!4 allows to skip tag prefix inside of the tag directory (i.e. to name files as extension.ini and extension.sys.ini) */ if (preg_match('#(?:^|/)([a-z]{2,3}-[A-Z]{2})[./]\w+(?:\.sys)?\.ini$#', $file, $match)) { // Try to validate the file $this->find($file, $match[1]); } } } /** * Reads and validates an ini file * * @param string $file - The path to the file * @param string $tag - Language tag code * * @return boolean True on success, otherwise False. */ protected function find($file, $tag) { $content = file_get_contents($file); if ($content === false) { return false; } // Check EOL format is \n (not \r or \n\r) if (strpos($content, "\r") !== false) { $this->report->addWarning($file, JText::_('COM_JEDCHECKER_LANG_INCORRECT_EOL')); } $lines = file($file); $nLines = count($lines); $keys = array(); // Use mb_check_encoding (if exists) to validate UTF-8 $mbExists = function_exists('mb_check_encoding'); for ($lineno = 0; $lineno < $nLines; $lineno++) { $startLineno = $lineno + 1; $line = trim($lines[$lineno]); // Check for BOM sequence if ($lineno === 0 && strncmp($line, "\xEF\xBB\xBF", 3) === 0) { if (isset($line[3]) && strpos(";\n\r", $line[3]) === false) { $this->report->addError($file, JText::_('COM_JEDCHECKER_LANG_BOM_FOUND'), $startLineno); } else { $this->report->addWarning($file, JText::_('COM_JEDCHECKER_LANG_BOM_FOUND'), $startLineno); } // Romeve BOM for further checks $line = substr($line, 3); } // Skip empty lines, comments, and section names if ($line === '' || $line[0] === ';' || $line[0] === '[') { continue; } // Report incorrect comment character if ($line[0] === '#') { $this->report->addError($file, JText::_('COM_JEDCHECKER_LANG_INCORRECT_COMMENT'), $startLineno, $line); continue; } // Check for "=" character in the line if (strpos($line, '=') === false) { $this->report->addError($file, JText::_('COM_JEDCHECKER_LANG_WRONG_LINE'), $startLineno, $line); continue; } // Extract key and value list ($key, $value) = explode('=', $line, 2); // Validate key $key = rtrim($key); // Check for empty key if ($key === '') { $this->report->addError($file, JText::_('COM_JEDCHECKER_LANG_KEY_EMPTY'), $startLineno, $line); continue; } // Check for spaces in the key name if (strpos($key, ' ') !== false) { $this->report->addError($file, JText::_('COM_JEDCHECKER_LANG_KEY_WHITESPACE'), $startLineno, $line); continue; } // Check for invalid characters (see https://www.php.net/manual/en/function.parse-ini-file.php) if (strpbrk($key, '{}|&~![()^"') !== false) { $this->report->addError($file, JText::_('COM_JEDCHECKER_LANG_KEY_INVALID_CHARACTER'), $startLineno, $line); continue; } // Check for invalid key names (see https://www.php.net/manual/en/function.parse-ini-file.php) if (in_array($key, array('null', 'yes', 'no', 'true', 'false', 'on', 'off', 'none'), true)) { $this->report->addError($file, JText::_('COM_JEDCHECKER_LANG_KEY_RESERVED'), $startLineno, $line); continue; } if (preg_match('/[\x00-\x1F\x80-\xFF]/', $key)) { $this->report->addWarning($file, JText::_('COM_JEDCHECKER_LANG_KEY_NOT_ASCII'), $startLineno, $line); } if ($key !== strtoupper($key)) { $this->report->addWarning($file, JText::_('COM_JEDCHECKER_LANG_KEY_NOT_UPPERCASE'), $startLineno, $line); } if (isset($keys[$key])) { $this->report->addWarning($file, JText::sprintf('COM_JEDCHECKER_LANG_KEY_DUPLICATED', $keys[$key]), $startLineno, $line); } else { $keys[$key] = $startLineno; } // Validate value $value = ltrim($value); // Parse multiline values while (!preg_match('/^((?>\'(?>[^\'\\\\]+|\\\\.)*\'|"(?>[^"\\\\]+|\\\\.)*"|[^\'";]+)*)(;.*)?$/', $value, $matches)) { if ($lineno + 1 >= $nLines) { break; } $lineno++; $chunk = "\n" . trim($lines[$lineno]); $line .= $chunk; $value .= $chunk; } if (!isset($matches[0])) { $this->report->addWarning($file, JText::_('COM_JEDCHECKER_LANG_TRANSLATION_ERROR'), $startLineno, $line); continue; } $value = trim($matches[1]); // Check for empty value if ($value === '""') { $this->report->addInfo($file, JText::_('COM_JEDCHECKER_LANG_TRANSLATION_EMPTY'), $startLineno, $line); continue; } // Check it's a valid UTF-8 string $validUTF8 = $mbExists ? mb_check_encoding($value, 'UTF-8') : preg_match('//u', $value); if (!$validUTF8) { $this->report->addWarning($file, JText::_('COM_JEDCHECKER_LANG_INVALID_UTF8'), $startLineno, $line); } if (strlen($value) < 2 || $value[0] !== '"' || substr($value, -1) !== '"') { $this->report->addError($file, JText::_('COM_JEDCHECKER_LANG_TRANSLATION_QUOTES'), $startLineno, $line); continue; } // // Remove quotes around $value = substr($value, 1, -1); // Check for legacy "_QQ_" code (deprecated since Joomla! 3.9 if favor of escaped double quote \"; removed in Joomla! 4) if (strpos($value, '"_QQ_"') !== false) { $this->report->addCompat($file, JText::_('COM_JEDCHECKER_LANG_QQ_DEPRECATED'), $startLineno, $line); } $value = str_replace('"_QQ_"', '\"', $value); if (preg_match('/[^\\\\]"/', $value)) { $this->report->addWarning($file, JText::_('COM_JEDCHECKER_LANG_UNESCAPED_QUOTE'), $startLineno, $line); } if (strpos($value, '${') !== false) { $this->report->addWarning($file, JText::_('COM_JEDCHECKER_LANG_VARIABLE_REF'), $startLineno, $line); } // The code below detects incorrect format of numbered placeholders (e.g. "%1s" instead of "%1$s") // Count numbered placeholders in the string (e.g. "%1s") $count = preg_match_all('/(?<=^|[^%])%(\d+)\w/', $value, $matches); if ($count) { // To avoid false-positives (e.g. %10s for a ten-characters-wide output string in a CLI), // we check that placeholder numbers form a sequence from 1 to N. $maxNumber = 0; foreach ($matches as $match) { $maxNumber = max($maxNumber, (int) $match[1]); } // If placeholder numbers form a sequence, the maximal value is equal to the number of elements if ($maxNumber === $count) { $this->report->addWarning($file, JText::_('COM_JEDCHECKER_LANG_INCORRECT_ARGNUM'), $startLineno, $line); } } } // All checks passed. Return true return true; } }