Multiple features

Able to specify a full file location for exclusion
("./folder/subfolder/file.ext")
Debug switch now available
External config file option

Author: lucanos

tripwire.php

@@ -1,4 +1,4 @@
-<pre><?php
+<?php
 
 /*
  *  Tripwire
@@ -18,56 +18,80 @@
  *
  */
 
-$config = array(
-
-  // File Containing the MD5 Keys
-  'md5file' => 'tripwire_filelist.md5' ,
-  // Delimited for Filelist
-  'delim' => '&&&' ,
-
-  'exclude' => array(
-    // Specific Files to Exclude from Scanning
-    'files' => array(
-      '.' ,
-      '..' ,
-      'tripwire_filelist.md5' ,
-      'error_log' ,
-      'backup.zip' ,
-      '.bash_history'
-    ) ,
-    // Extensions to Exclude from Scanning
-    'extensions' => array(
-      'afm' ,
-      // Flash
-      'flv' , 'swf' ,
-      // Images
-      'bmp' , 'gif' , 'jpeg' , 'jpg' , 'png' , 'psd' ,
-      'log' ,
-      'txt' ,
-      // Videos
-      'mp4' , 'mov' , 'ogv' , 'webm' ,
-      // Dreamweaver
-      'mno' ,
-      // Audio
-      'aif' , 'mp3' ,
-      // Microsoft Word Files
-      'doc' , 'docx' , 'xls' , 'xlsx' ,
-      // Compressed Files
-      '7z' , 'rar' , 'sitx' , 'zip'
-    ) ,
-    'reg'
-  ) ,
+set_time_limit( 0 );
+
+if( file_exists( 'tripwire_config.php' ) ){
+
+ # Standalone Config File (for easy upgrading of this file)
+  require_once( 'tripwire_config.php' );
+
+}else{
 
-  'email' => array(
-    'to' => array(            // Email these people on changes
-      // 'user@server.com'
+ # Default Configuration
+  $config = array(
+
+    // Debugging (Verbose Output)
+    'debug' => false ,
+
+    // File Containing the MD5 Keys
+    'md5file' => 'tripwire_filelist.md5' ,
+    // Delimited for Filelist
+    'delim' => '&&&' ,
+
+    'exclude' => array(
+      // Specific Files to Exclude from Scanning
+      'files' => array(
+        '.' ,
+        '..' ,
+        'tripwire_filelist.md5' ,
+        'tripwire_config.php' ,
+        'error_log' ,
+        'backup.zip' ,
+        '.bash_history'
+      ) ,
+      // Extensions to Exclude from Scanning
+      'extensions' => array(
+        'afm' ,
+        // Flash
+        'flv' , 'swf' ,
+        // Images
+        'bmp' , 'gif' , 'jpeg' , 'jpg' , 'png' , 'psd' ,
+        'log' ,
+        'txt' ,
+        // Videos
+        'mp4' , 'mov' , 'ogv' , 'webm' ,
+        // Dreamweaver
+        'mno' ,
+        // Audio
+        'aif' , 'mp3' ,
+        // Microsoft Word Files
+        'doc' , 'docx' , 'xls' , 'xlsx' ,
+        // Compressed Files
+        '7z' , 'rar' , 'sitx' , 'zip'
+      )
     ) ,
-    'title' => '[Tripwire] Change Detected - [X] Files' , // The Email Title
-    'body' => "Tripwire (https://github.com/lucanos/Tripwire) has detected a number of changes:\n\n[AN] Files Added:\n[AF]\n\n[MN] Files Modified:\n[MF]\n\n[DN] Files Deleted:\n[DF]\n\n"   // The Email Template
-  )
 
-);
+    'email' => array(
+      'to' => array(            // Email these people on changes
+        // 'user@server.com'
+      ) ,
+      'title' => '[Tripwire] Change Detected - [X] Files' , // The Email Title
+      'body' => "Tripwire (https://github.com/lucanos/Tripwire) has detected a number of changes:\n\n[AN] Files Added:\n[AF]\n\n[MN] Files Modified:\n[MF]\n\n[DN] Files Deleted:\n[DF]\n\n"   // The Email Template
+    )
+
+  );
+
+}
+
+
 
+define( 'DEBUG' , isset( $config['debug'] ) && $config['debug'] );
+
+
+function debugMsg( $msg = false ){
+  if( DEBUG && $msg )
+    echo $msg;
+}
 
 
 function run_tripwire( $dir=false ){
@@ -82,32 +106,52 @@ function run_tripwire( $dir=false ){
     $dir = substr( $dir , 0 , -1 );
 
   // If the supplied variable is not a Directory, terminate
-  if( !is_dir( $dir ) )
+  if( !is_dir( $dir ) ){
+    debugMsg( "Directory '$dir' does not exist.\n" );
     return false;
+  }
+  debugMsg( "Checking directory '$dir'\n" );
 
   $temp = array();
   $d = dir( $dir );
 
   // Loop through the files
   while( false!==( $entry = $d->read() ) ){
+  
+    // Full Entry (including Directory)
+    $entry_full = $dir.'/'.$entry;
+    
+    // Debugging
+    debugMsg( "<tr><th align='left'>$entry_full</th>" );
+      
     // Symbolic Link - Excluded
-    if( is_link( $entry ) )
+    if( is_link( $entry ) ){
+      debugMsg( "<td><em>Symbolic Link</em></td></tr>\n" );
       continue;
+    }
 
     // Excluded File/Folder
-    if( in_array( $entry , $config['exclude']['files'] ) )
+    if( $f1 = in_array( $entry , $config['exclude']['files'] )
+        || in_array( $entry_full , $config['exclude']['files'] ) ){
+      debugMsg( "<td><em>Excluded File/Folder (".array_search( isset( $f1 ) && $f1 ? $entry : $entry_full , $config['exclude']['files'] ).")</em></td></tr>\n" );
       continue;
+    }
 
     // Excluded File Extension
-    if( in_array( pathinfo( $entry , PATHINFO_EXTENSION ) , $config['exclude']['extensions'] ) )
+    if( in_array( pathinfo( $entry , PATHINFO_EXTENSION ) , $config['exclude']['extensions'] ) ){
+      debugMsg( "<td><em>Excluded File Extension (".array_search( pathinfo( $entry , PATHINFO_EXTENSION ) , $config['exclude']['extensions'] ).")</em></td></tr>\n" );
       continue;
+    }
 
     if( is_dir( $dir.'/'.$entry ) ){
       // Recurse
+      debugMsg( "<td>Directory - Recursing</td></tr>\n" );
       $temp = array_merge( $temp , run_tripwire( $dir.'/'.$entry ) );
     }else{
       $md5 = @md5_file( $dir.'/'.$entry );
+      debugMsg( "<td>$md5</td></tr>\n" );
       if( !$md5 ){
+        debugMsg( "<td><strong>Unreadable. Adding to Unreadable List.</strong></td></tr>\n" );
         file_put_contents( 'tripwire_unreadable.txt' ,  "{$dir}/{$entry} - Unreadable\n" , FILE_APPEND );
       }else{
         $temp[$dir.'/'.$entry] = $md5;
@@ -154,11 +198,35 @@ function file_put_contents( $filename , $data ){
 
 
 
+// Format
+if( DEBUG ){
+?>
+<pre><?php var_dump( $config['exclude'] ); ?></pre>
+<table border="1" cellpadding="2" cellspacing="0">
+  <thead>
+    <tr>
+      <th>File</th>
+      <th>Result</th>
+    </tr>
+  </thead>
+  <tbody>
+<?php
+}
+
+
 // Init the This Check List
 $now = run_tripwire( '.' );
 
 
 
+if( DEBUG ){
+?>
+  </tbody>
+</table>
+<?php
+}
+
+
 // Perform Comparisons
 
 // New Files = Files in $now, but not in $last
@@ -171,16 +239,18 @@ function file_put_contents( $filename , $data ){
 $modified = array_diff_assoc( array_intersect_key( $last , $now ) , array_intersect_key( $now , $last ) );
 
 
+if( DEBUG ){
 
-echo "\$new\n";
-var_dump( $new );
-
-echo "\$deleted\n";
-var_dump( $deleted );
-
-echo "\$modified\n";
-var_dump( $modified );
+  echo '<pre>';
+  echo "\$new\n";
+  var_dump( $new );
+  echo "\$deleted\n";
+  var_dump( $deleted );
+  echo "\$modified\n";
+  var_dump( $modified );
+  echo '</pre>';
 
+}
 
 
 if( !count( $last ) // If there was no file list
@@ -203,48 +273,97 @@ function file_put_contents( $filename , $data ){
 
 
 // If there was a Filelist from the last run to compare against, and changes have occurred
+
+  # Changes Detected
+
+// Prepare Report
+
 if( count( $last )
     && ( count( $new ) || count( $deleted ) || count( $modified ) ) ){
-
   # Changes Detected
 
-  // If there are email addresses to notify
-  if( count( $config['email']['to'] ) ){
+  // Prepare the placeholder details
+  $body_replacements = array(
+    '[AN]' => count( $new ) ,
+    '[AF]' => ( count( $new ) ? implode( "\n" , $new ) : 'No Files' ) ,
+    '[MN]' => count( $modified ) ,
+    '[MF]' => ( count( $modified ) ? implode( "\n" , array_keys( $modified ) ) : 'No Files' ) ,
+    '[DN]' => count( $deleted ) ,
+    '[DF]' => ( count( $deleted ) ? implode( "\n" , $deleted ) : 'No Files' ) ,
+  );
+  $title = str_replace( '[X]' , ( count( $new )+count( $deleted )+count( $modified ) ) , $config['email']['title'] );
+  
+  // Send Email Flag
+  $sendEmail = true;
+
+}elseif( count( $last ) ){
+ # No Changes Detected
+
+  // Prepare the placeholder details
+  $body_replacements = array(
+    '[AN]' => 0 ,
+    '[AF]' => 'No Files' ,
+    '[MN]' => 0 ,
+    '[MF]' => 'No Files' ,
+    '[DN]' => 0 ,
+    '[DF]' => 'No Files' ,
+  );
+  $title = str_replace( '[X]' , 0 , $config['email']['title'] );
+  
+  // Send Email Flag
+  $sendEmail = false;
+
+}else{
+ # First Run
+
+  // Prepare the placeholder details
+  $body_replacements = array(
+    '[AN]' => count( $new ) ,
+    '[AF]' => ( count( $new ) ? implode( "\n" , $new ) : 'No Files' ) ,
+    '[MN]' => 0 ,
+    '[MF]' => 'No Files' ,
+    '[DN]' => 0 ,
+    '[DF]' => 'No Files' ,
+  );
+  $title = str_replace( '[X]' , count( $new ) , $config['email']['title'] );
+  
+  // Adjust the Template
+  $config['email']['body'] = "Tripwire has made it's first pass of your files.\n\n".$config['email']['body'];
+  
+  // Send Email Flag
+  $sendEmail = true;
+
+}
+
+
+// Perform the Placeholder Substitutions within the Body
+$body = str_replace(
+          array_keys( $body_replacements ) ,
+          $body_replacements ,
+          $config['email']['body']
+        );
+
 
-    # Compile the Email
+if( count( $config['email']['to'] ) ){
 
-    // Prepare the placeholder details
-    $body_replacements = array(
-      '[AN]' => count( $new ) ,
-      '[AF]' => ( count( $new ) ? implode( "\n" , $new ) : 'No Files' ) ,
-      '[MN]' => count( $modified ) ,
-      '[MF]' => ( count( $modified ) ? implode( "\n" , array_keys( $modified ) ) : 'No Files' ) ,
-      '[DN]' => count( $deleted ) ,
-      '[DF]' => ( count( $deleted ) ? implode( "\n" , $deleted ) : 'No Files' ) ,
-    );
+  if( $sendEmail ){
 
     // Prepare the recipients
     $to = implode( ', ' , $config['email']['to'] );
-    // Prepare the Subject Line
-    $title = str_replace( '[X]' , ( count( $new )+count( $deleted )+count( $modified ) ) , $config['email']['title'] );
-    // Perform the Placeholder Substitutions within the Body
-    $body = str_replace(
-              array_keys( $body_replacements ) ,
-              $body_replacements ,
-              $config['email']['body']
-            );
-
     // Send it
     if( mail( $to , $title , $body ) ){
       echo "Email Sent Successfully\n";
     }else{
       echo "Email Failed\n";
     }
-
+    
+  }else{
+  
+    // No Email Needed
+  
   }
-
+  
 }else{
-
-  # No Changes Detected
-
+  // Just echo the result
+  echo '<pre>'.$body.'</pre>';
 }