Mega Code Archive
Search and Replace class
<![CDATA[
<?php
class search_replace{
var $find;
var $replace;
var $files;
var $directories;
var $include_subdir;
var $ignore_lines;
var $ignore_sep;
var $occurences;
var $search_function;
var $last_error;
/**
** Constructor function. Sets up the
** above functions.
**/
function search_replace($find, $replace, $files, $directories = '', $include_subdir = 1, $ignore_lines = array()){
$this->find = $find;
$this->replace = $replace;
$this->files = $files;
$this->directories = $directories;
$this->include_subdir = $include_subdir;
$this->ignore_lines = $ignore_lines;
$this->occurences = 0;
$this->search_function = 'search';
$this->last_error = '';
}
/*
** Accessor for retrieving occurences.
**/
function get_num_occurences(){
return $this->occurences;
}
/*
** Accessor for retrieving last error.
*/
function get_last_error(){
return $this->last_error;
}
/*
** Accessor for setting find variable.
*/
function set_find($find){
$this->find = $find;
}
/*
** Accessor for setting replace variable.
*/
function set_replace($replace){
$this->replace = $replace;
}
/*
** Accessor for setting files variable.
*/
function set_files($files){
$this->files = $files;
}
/*
** Accessor for setting directories variable.
*/
function set_directories($directories){
$this->directories = $directories;
}
/*
** Accessor for setting include_subdir variable.
*/
function set_include_subdir($include_subdir){
$this->include_subdir = $include_subdir;
}
/**
** Accessor for setting ignore_lines variable.
*/
function set_ignore_lines($ignore_lines){
$this->ignore_lines = $ignore_lines;
}
/*
** Function to determine which search
** function is used.
*/
function set_search_function($search_function){
switch($search_function){
case 'normal': $this->search_function = 'search';
return TRUE;
break;
case 'quick' : $this->search_function = 'quick_search';
return TRUE;
break;
case 'preg' : $this->search_function = 'preg_search';
return TRUE;
break;
case 'ereg' : $this->search_function = 'ereg_search';
return TRUE;
break;
default : $this->last_error = 'Invalid search function specified';
return FALSE;
break;
}
}
/*
** The main search and replace routine.
** Private function - DO NOT CALL!
*/
function search($filename){
$occurences = 0;
$file_array = file($filename);
for($i=0; $i<count($file_array); $i++){
if(count($this->ignore_lines) > 0){
for($j=0; $j<count($this->ignore_lines); $j++){
if(substr($file_array[$i],0,strlen($this->ignore_lines[$j])) == $this->ignore_lines[$j]) continue 2;
}
}
$occurences += count(explode($this->find, $file_array[$i])) - 1;
$file_array[$i] = str_replace($this->find, $this->replace, $file_array[$i]);
}
if($occurences > 0) $return = array($occurences, implode('', $file_array)); else $return = FALSE;
return $return;
}
/*
** The quick search function. Does not
** support the ignore_lines feature.
*/
function quick_search($filename){
clearstatcache();
$file = fread($fp = fopen($filename, 'r'), filesize($filename)); fclose($fp);
$occurences = count(explode($this->find, $file)) - 1;
$file = str_replace($this->find, $this->replace, $file);
if($occurences > 0) $return = array($occurences, $file); else $return = FALSE;
return $return;
}
/*
** The preg search function. Does not
** support the ignore_lines feature.
*/
function preg_search($filename){
clearstatcache();
$file = fread($fp = fopen($filename, 'r'), filesize($filename)); fclose($fp);
$occurences = count($matches = preg_split($this->find, $file)) - 1;
$file = preg_replace($this->find, $this->replace, $file);
if($occurences > 0) $return = array($occurences, $file); else $return = FALSE;
return $return;
}
/*
** The ereg search function. Does not
** support the ignore_lines feature.
*/
function ereg_search($filename){
clearstatcache();
$file = fread($fp = fopen($filename, 'r'), filesize($filename)); fclose($fp);
$occurences = count($matches = split($this->find, $file)) -1;
$file = ereg_replace($this->find, $this->replace, $file);
if($occurences > 0) $return = array($occurences, $file); else $return = FALSE;
return $return;
}
/*
** Function for writing out a new file.
*/
function writeout($filename, $contents){
if($fp = @fopen($filename, 'w')){
flock($fp,2);
fwrite($fp, $contents);
flock($fp,3);
fclose($fp);
}else{
$this->last_error = 'Could not open file: '.$filename;
}
}
/*
** Internal function called by do_search()
** to sort out any files that need searching.
*/
function do_files($ser_func){
if(!is_array($this->files)) $this->files = explode(',', $this->files);
for($i=0; $i<count($this->files); $i++){
if($this->files[$i] == '.' OR $this->files[$i] == '..') continue;
if(is_dir($this->files[$i]) == TRUE) continue;
$newfile = $this->$ser_func($this->files[$i]);
if(is_array($newfile) == TRUE){
$this->writeout($this->files[$i], $newfile[1]);
$this->occurences += $newfile[0];
}
}
}
/*
** Internal function called by do_search()
** to sort out any dirs that need searching.
*/
function do_directories($ser_func){
if(!is_array($this->directories)) $this->directories = explode(',', $this->directories);
for($i=0; $i<count($this->directories); $i++){
$dh = opendir($this->directories[$i]);
while($file = readdir($dh)){
if($file == '.' OR $file == '..') continue;
if(is_dir($this->directories[$i].$file) == TRUE){
if($this->include_subdir == 1){
$this->directories[] = $this->directories[$i].$file.'/';
continue;
}else{
continue;
}
}
$newfile = $this->$ser_func($this->directories[$i].$file);
if(is_array($newfile) == TRUE){
$this->writeout($this->directories[$i].$file, $newfile[1]);
$this->occurences += $newfile[0];
}
}
}
}
/**
** This starts the search/replace off.
** Call this to do the search.
** First do whatever files are specified,
** and/or if directories are specified,
** do those too.
*/
function do_search(){
if($this->find != ''){
if((is_array($this->files) AND count($this->files) > 0) OR $this->files != '') $this->do_files($this->search_function);
if($this->directories != '') $this->do_directories($this->search_function);
}
}
} // End of class
?>
<?php
include('class.search_replace.inc');
/*
** Create the object, set the search
** function and run it. Then change the
** pattern to find something else, and
** re-run the search.
*/
$sr = new file_search_replace('test', 'Replaced!', array('test.txt'), '', 1, array('##'));
/**
** Following function not necessary as
** normal is the default, but here to
** illustrate it.
*/
$sr->set_search_function('normal');
$sr->do_search();
$sr->set_find('another');
$sr->do_search();
/*
** Some ouput purely for the example.
*/
header('Content-Type: text/plain');
echo 'Number of occurences found: '.$sr->get_num_occurences()."\r\n";
echo 'Error message.............: '.$sr->get_last_error()."\r\n";
?>
]]>