Class to enable search/replace of files. Can perform the search over one file, multiple files, entire directories with/without subdirectories. Can search using four different search functions, supporting ereg and preg regular expressions.
WebsiteBy : Matt
<?php
/***************************************
** Title........: Search and replace utility
** Filename.....: search.replace.php
** Author.......: Richard Heyes
** Version......: 1.0
** Notes........:
** Last changed.: 09/09/2000
** Last change..:
***************************************/
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
/***************************************
** Title........: Search and Replace class
** Filename.....: example.php
** Author.......: Richard Heyes
** Version......: See script
** Notes........:
** Last changed.: 10/09/2000
** Last change..:
***************************************/
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";
?>
| DISCLAIMER: The content provided in this article is not warranted or guaranteed by Developer Shed, Inc. The content provided is intended for entertainment and/or educational purposes in order to introduce to the reader key ideas, concepts, and/or product reviews. As such it is incumbent upon the reader to employ real-world tactics for security and implementation of best practices. We are not liable for any negative consequences that may result from implementing any information covered in our articles or tutorials. If this is a hardware review, it is not recommended to open and/or modify your hardware. |
More Search Code Articles
More By Codewalkers
developerWorks - FREE Tools! |
You'll get answers to many questions and more from David Barnes, Lead Evangelist for IBM Emerging Internet Technologies. David will discuss aspects of Web 2.0 that bring value to corporations, academia, and government. He'll also discuss IBM's vision around Web 2.0, including the importance of remixability and consumability. The discussion will culminate with examples of various IBM Software Group solutions you can use to get ahead of the Web 2.0 adoption curve. FREE! Go There Now!
|
|
|
|
As businesses grow increasingly dependent upon Web applications to provide services to customers, employees and partners, these complex applications become more difficult to secure. Although traditional security solutions protect Internet infrastructure layers, they do not guard against HTTP and HTML attacks. Many organizations that conduct security testing still deploy applications that allow attackers to manipulate their logic and wreak havoc on their business. To mitigate this risk, development and delivery teams must address Web application security throughout the lifecycle, addressing the many layers detailed in this paper. FREE! Go There Now!
|
|
|
|
Attend this launch webcast with Scott Hebner, Vice President of IBM Rational Marketing and Strategy, for an overview of Rational’s new software offerings and resources to help modernize and accelerate software innovation on i on Power Systems – while ensuring past application investments are protected and continue to grow. Learn how these solutions are helping customers extend their core i5/OS solutions toward modern architectures such as SOA and web technologies to deliver business improvements that stand the test of time. FREE! Go There Now!
|
|
|
|
CakePHP is a stable production-ready, rapid-development aid for building Web sites in PHP. This "Cook up Web sites fast with CakePHP" series shows you how to build an online product catalog using CakePHP. FREE! Go There Now!
|
|
|
|
This tutorial shows new users of IBM WebSphere Business Monitor Version 6.0.2 how to perform the "Hello World" equivalent for monitoring business process applications. It is intended to help you get familiar with the capabilities of the product. FREE! Go There Now!
|
|
|
|
Manage, govern, and share services across your organization by using WebSphere Service Registry and Repository. Follow the hands-on exercises to learn how to navigate the Web interface to publish, find, reuse, and update services. FREE! Go There Now!
|
|
|
|
Learn how Rational Build Forge can extend a simple compile and package build process by adding customization and deployment capability. Go from a manual method to automating: checking for code changes; getting the latest source; compiling and packaging; customizing; copying to and restarting a deployment server; and sending e-mail notification that a new version is available. FREE! Go There Now!
|
|
|
|
Join this Rational Talks to You teleconference on December 6 at 1:00 pm ET to participate in an agile application development discussion and get your questions answered on using IBM Rational Method Composer in a distributed environment.Get your questions answered! FREE! Go There Now!
|
|
|
|
Visit IBM developerWorks to try the IBM SOA Sandbox for people. The SOA Sandbox for people provides a trial environment with the necessary tooling and components required to enable consistent human and process interaction and collaboration, showing how you can improve user experience and business productivity. FREE! Go There Now!
|
|
|
|
Attend this launch webcast with Scott Hebner, Vice President of IBM Rational Marketing and Strategy, where he will overview Rational’s new offerings and programs to help customers accelerate software innovation on System z. He will discuss how these solutions help organizations extend their core business processes toward modern architectures such as SOA and web technologies to deliver business improvements that stand the test of time. FREE! Go There Now!
|
|
|
|
All FREE IBM® developerWorks Tools! |