PhpExtractor.php 6.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258
  1. <?php
  2. /*
  3. * This file is part of the Symfony package.
  4. *
  5. * (c) Fabien Potencier <fabien@symfony.com>
  6. *
  7. * For the full copyright and license information, please view the LICENSE
  8. * file that was distributed with this source code.
  9. */
  10. namespace Symfony\Component\Translation\Extractor;
  11. use Symfony\Component\Finder\Finder;
  12. use Symfony\Component\Translation\MessageCatalogue;
  13. /**
  14. * PhpExtractor extracts translation messages from a PHP template.
  15. *
  16. * @author Michel Salib <michelsalib@hotmail.com>
  17. */
  18. class PhpExtractor extends AbstractFileExtractor implements ExtractorInterface
  19. {
  20. const MESSAGE_TOKEN = 300;
  21. const METHOD_ARGUMENTS_TOKEN = 1000;
  22. const DOMAIN_TOKEN = 1001;
  23. /**
  24. * Prefix for new found message.
  25. *
  26. * @var string
  27. */
  28. private $prefix = '';
  29. /**
  30. * The sequence that captures translation messages.
  31. *
  32. * @var array
  33. */
  34. protected $sequences = array(
  35. array(
  36. '->',
  37. 'trans',
  38. '(',
  39. self::MESSAGE_TOKEN,
  40. ',',
  41. self::METHOD_ARGUMENTS_TOKEN,
  42. ',',
  43. self::DOMAIN_TOKEN,
  44. ),
  45. array(
  46. '->',
  47. 'transChoice',
  48. '(',
  49. self::MESSAGE_TOKEN,
  50. ',',
  51. self::METHOD_ARGUMENTS_TOKEN,
  52. ',',
  53. self::METHOD_ARGUMENTS_TOKEN,
  54. ',',
  55. self::DOMAIN_TOKEN,
  56. ),
  57. array(
  58. '->',
  59. 'trans',
  60. '(',
  61. self::MESSAGE_TOKEN,
  62. ),
  63. array(
  64. '->',
  65. 'transChoice',
  66. '(',
  67. self::MESSAGE_TOKEN,
  68. ),
  69. );
  70. /**
  71. * {@inheritdoc}
  72. */
  73. public function extract($resource, MessageCatalogue $catalog)
  74. {
  75. $files = $this->extractFiles($resource);
  76. foreach ($files as $file) {
  77. $this->parseTokens(token_get_all(file_get_contents($file)), $catalog);
  78. if (\PHP_VERSION_ID >= 70000) {
  79. // PHP 7 memory manager will not release after token_get_all(), see https://bugs.php.net/70098
  80. gc_mem_caches();
  81. }
  82. }
  83. }
  84. /**
  85. * {@inheritdoc}
  86. */
  87. public function setPrefix($prefix)
  88. {
  89. $this->prefix = $prefix;
  90. }
  91. /**
  92. * Normalizes a token.
  93. *
  94. * @param mixed $token
  95. *
  96. * @return string
  97. */
  98. protected function normalizeToken($token)
  99. {
  100. if (isset($token[1]) && 'b"' !== $token) {
  101. return $token[1];
  102. }
  103. return $token;
  104. }
  105. /**
  106. * Seeks to a non-whitespace token.
  107. */
  108. private function seekToNextRelevantToken(\Iterator $tokenIterator)
  109. {
  110. for (; $tokenIterator->valid(); $tokenIterator->next()) {
  111. $t = $tokenIterator->current();
  112. if (T_WHITESPACE !== $t[0]) {
  113. break;
  114. }
  115. }
  116. }
  117. private function skipMethodArgument(\Iterator $tokenIterator)
  118. {
  119. $openBraces = 0;
  120. for (; $tokenIterator->valid(); $tokenIterator->next()) {
  121. $t = $tokenIterator->current();
  122. if ('[' === $t[0] || '(' === $t[0]) {
  123. ++$openBraces;
  124. }
  125. if (']' === $t[0] || ')' === $t[0]) {
  126. --$openBraces;
  127. }
  128. if ((0 === $openBraces && ',' === $t[0]) || (-1 === $openBraces && ')' === $t[0])) {
  129. break;
  130. }
  131. }
  132. }
  133. /**
  134. * Extracts the message from the iterator while the tokens
  135. * match allowed message tokens.
  136. */
  137. private function getValue(\Iterator $tokenIterator)
  138. {
  139. $message = '';
  140. $docToken = '';
  141. for (; $tokenIterator->valid(); $tokenIterator->next()) {
  142. $t = $tokenIterator->current();
  143. if (!isset($t[1])) {
  144. break;
  145. }
  146. switch ($t[0]) {
  147. case T_START_HEREDOC:
  148. $docToken = $t[1];
  149. break;
  150. case T_ENCAPSED_AND_WHITESPACE:
  151. case T_CONSTANT_ENCAPSED_STRING:
  152. $message .= $t[1];
  153. break;
  154. case T_END_HEREDOC:
  155. return PhpStringTokenParser::parseDocString($docToken, $message);
  156. default:
  157. break 2;
  158. }
  159. }
  160. if ($message) {
  161. $message = PhpStringTokenParser::parse($message);
  162. }
  163. return $message;
  164. }
  165. /**
  166. * Extracts trans message from PHP tokens.
  167. *
  168. * @param array $tokens
  169. * @param MessageCatalogue $catalog
  170. */
  171. protected function parseTokens($tokens, MessageCatalogue $catalog)
  172. {
  173. $tokenIterator = new \ArrayIterator($tokens);
  174. for ($key = 0; $key < $tokenIterator->count(); ++$key) {
  175. foreach ($this->sequences as $sequence) {
  176. $message = '';
  177. $domain = 'messages';
  178. $tokenIterator->seek($key);
  179. foreach ($sequence as $sequenceKey => $item) {
  180. $this->seekToNextRelevantToken($tokenIterator);
  181. if ($this->normalizeToken($tokenIterator->current()) === $item) {
  182. $tokenIterator->next();
  183. continue;
  184. } elseif (self::MESSAGE_TOKEN === $item) {
  185. $message = $this->getValue($tokenIterator);
  186. if (count($sequence) === ($sequenceKey + 1)) {
  187. break;
  188. }
  189. } elseif (self::METHOD_ARGUMENTS_TOKEN === $item) {
  190. $this->skipMethodArgument($tokenIterator);
  191. } elseif (self::DOMAIN_TOKEN === $item) {
  192. $domain = $this->getValue($tokenIterator);
  193. break;
  194. } else {
  195. break;
  196. }
  197. }
  198. if ($message) {
  199. $catalog->set($message, $this->prefix.$message, $domain);
  200. break;
  201. }
  202. }
  203. }
  204. }
  205. /**
  206. * @param string $file
  207. *
  208. * @return bool
  209. *
  210. * @throws \InvalidArgumentException
  211. */
  212. protected function canBeExtracted($file)
  213. {
  214. return $this->isFile($file) && 'php' === pathinfo($file, PATHINFO_EXTENSION);
  215. }
  216. /**
  217. * @param string|array $directory
  218. *
  219. * @return array
  220. */
  221. protected function extractFromDirectory($directory)
  222. {
  223. $finder = new Finder();
  224. return $finder->files()->name('*.php')->in($directory);
  225. }
  226. }