Batch script to replace PHP short open tags with <?php

Question

Hello everyone,

I have a large collection of php files written over the years and I need to properly replace all the short open tags into proper explicit open tags.

change "<?" into "<?php"

I think this regular expression will properly select them :

<\?(\s|\n|\t|[^a-zA-Z])

which takes care of cases like

<?//
<?/*

but I am not sure how to process a whole folder tree + detect the .php file extension + apply the regular expression + save the file it it has been changed.

I have the feeling this can be pretty straightforward if you master the right tools. (There is an interesting hack in the sed manual : 4.3 Example/Lowercase to Uppercase)
Maybe I'm wrong.
Or maybe this could be a one liner?

Thank you for your help.

Answer 1

My previous answer I just overwrote with sed wont work, sed is too weak for this sort of thing IMO.

So I've whipped up a perl-script that should do the trick, its hopefully very user-editable.

#!/usr/bin/perl 

use strict;
use warnings;

use File::Find::Rule;
use Carp;

my @files = File::Find::Rule->file()->name('*.php')->in('/tmp/foo/bar');

for my $file (@files) {
    rename $file, $file . '.orig';
    open my $output, '>', $file or Carp::croak("Write Error with $file $! $@ ");
    open my $input, '<', $file . '.orig'
      or Carp::croak("Read error with $file.orig $! $@");

    while ( my $line = <$input> ) {
        # Replace <?= with <?php echo 
        $line =~ s/<\?=/<?php echo /g;

        # Replace <? ashded  with <?php ashed

        $line =~ s/<\?(?!php|xml)/<?php /g;
        print $output $line;
    }

    close $input  or Carp::carp(" Close error with $file.orig, $! $@");
    close $output or Carp::carp(" Close error with $file  , $! $@");

    unlink $file . '.orig';
}

But note, I haven't tested this on any real code, so It could go "Bang" .

I would recommend you have your code revisioned ( wait, its already revisioned, right? .. right? ) and run your test-suite ( Don't tell me you don't have tests ! ) on the modified code, because you can't be certain its doing the right thing without a fully fledged FSM parser.

Answer 2

don't use regexps for parsing formal languages - you'll always run into haystacks you did not anticipate. like:

<?
$bla = '?> now what? <?';

it's safer to use a processor that knows about the structure of the language. for html, that would be a xml processor; for php, the built-in tokenizer extension. it has the T_OPEN_TAG parser token, which matches <?php, <? or <%, and T_OPEN_TAG_WITH_ECHO, which matches <?= or <%=. to replace all short open tags, you find all these tokens and replace T_OPEN_TAG with <?php and T_OPEN_TAG_WITH_ECHO with <?php echo .

the implementation is left as an exercise for the reader :)

EDIT 1: ringmaster was so kind to provide one.

EDIT 2: on systems with short_open_tag turned off in php.ini, <?, <%, and <?= won't be recognized by a replacement script. to make the script work on such systems, enable short_open_tag via command line option:

php -d short_open_tag=On short_open_tag_replacement_script.php

p.s. the man page for token_get_all() and googleing for creative combinations of tokenizer, *token_get_all*, and the parser token names might help.

p.p.s. see also Regex to parse define() contents, possible? here on SO

Answer 3

It's typical for XML/XHTML pages to include following code:

<?php echo '<?xml version="1.0" encoding="UTF-8" ?>'; ?>

Of course that should not be changed neither to:

<?phpphp echo '<?phpxml version="1.0" encoding="UTF-8" ?>'; ?>

nor:

<?php echo '<?phpxml version="1.0" encoding="UTF-8" ?>'; ?>

Answer 4

If you're using the tokenizer option, this might be helpful:

$content = file_get_contents($file);
$tokens = token_get_all($content);
$output = '';

foreach($tokens as $token) {
 if(is_array($token)) {
  list($index, $code, $line) = $token;
  switch($index) {
   case T_OPEN_TAG_WITH_ECHO:
    $output .= '<?php echo ';
    break;
   case T_OPEN_TAG:
    $output .= '<?php ';
    break;
   default:
    $output .= $code;
    break;
  }

 }
 else {
  $output .= $token;
 }
}
return $output;

Note that the tokenizer will not properly tokenize short tags if short tags aren't enabled. That is, you can't run this code on the system where short tags aren't working. You must run it elsewhere to convert the code.

Answer 5

That's my version of the RegExp:

<\?(?!(php|=|xml))(\s|\t|\n)

Answer 6

solution on Python

http://ciupu.elektroda.eu/?p=26

Answer 7

This is a utility I wrote that converts PHP source that contains short open tags and replaces them with long tags.

• http://puny.it/pRXnHFZB

i.e. it converts code like this:

  <?= $var1 ?>
  <? printf("%u changes\n",$changes) ?>

To this

  <?php echo $var1 ?>
  <?php printf("%u changes\n",$changes) ?>

The --skip-echo-tags option will cause it to skip <?= tags and only replace <? tags.

It’s written as a PHP-CLI script and needs the CLI php.ini file to be set to permit short short open tags. That’s the default setting for PHP 5.3.0 and earlier, but it might not always remain so. (The script simply won’t change anything if the setting isn’t enabled.)