source.php

1 lines ASCII Unix (LF)
1
<?php
/**
 * Class for display sourcecode.
 *
 * @author Mikael Roos, me@mikaelroos.se
 * @copyright Mikael Roos 2010 - 2014
 * @link https://github.com/mosbth/csource
 */
class CSource {

  /**
   * Properties
   */
  private $options = array();

  /**
   * Constructor
   *
   * @param array $options to alter the default behaviour.
   */
  public function __construct($options=array()) {
    $default = array(
      'image_extensions' => array('png', 'jpg', 'jpeg', 'gif', 'ico'),
      'spaces_to_replace_tab' => '  ',
      'ignore' => array('.', '..', '.git', '.svn', '.netrc', '.ssh'),
      'add_ignore' => null, // add array with additional filenames to ignore
      'secure_dir' => '.',  // Only display files below this directory
      'base_dir'   => '.',  // Which directory to start look in, defaults to current working directory of the actual script.
      'query_dir'  => isset($_GET['dir'])  ? strip_tags(trim($_GET['dir']))   : null, // Selected directory as ?dir=xxx
      'query_file' => isset($_GET['file']) ? strip_tags(trim($_GET['file']))  : null, // Selected directory as ?dir=xxx
      'query_path' => isset($_GET['path']) ? strip_tags(trim($_GET['path']))  : null, // Selected directory as ?dir=xxx
    );

    // Add more files to ignore
    if(isset($options['add_ignore'])) {
      $default['ignore'] = array_merge($default['ignore'], $options['add_ignore']);
    }
    
    $this->options = $options = array_merge($default, $options);

    //Backwards compatible with source.php query arguments for ?dir=xxx&file=xxx
    if(!isset($this->options['query_path'])) {
      $this->options['query_path'] = trim($this->options['query_dir'] . '/' . $this->options['query_file'], '/');
    }

    $this->validImageExtensions = $options['image_extensions'];
    $this->spaces         = $options['spaces_to_replace_tab'];
    $this->ignore         = $options['ignore'];
    $this->secureDir      = realpath($options['secure_dir']);
    $this->baseDir        = realpath($options['base_dir']);
    $this->queryPath      = $options['query_path'];
    $this->suggestedPath  = $this->baseDir . '/' . $this->queryPath;
    $this->realPath       = realpath($this->suggestedPath);
    $this->pathinfo       = pathinfo($this->realPath);
    $this->path           = null;

    if(is_dir($this->realPath)) {
      $this->file = null;
      $this->extension = null;
      $this->dir  = $this->realPath;
      $this->path = trim($this->queryPath, '/');
    }
    else if(is_link($this->suggestedPath)) {
      $this->pathinfo = pathinfo($this->suggestedPath);
      $this->file = $this->pathinfo['basename'];
      $this->extension = strtolower($this->pathinfo['extension']);
      $this->dir  = $this->pathinfo['dirname'];
      $this->path = trim(dirname($this->queryPath), '/');
    }
    else if(is_readable($this->realPath)) {
      $this->file = basename($this->realPath);
      $this->extension = strtolower($this->pathinfo['extension']);
      $this->dir  = dirname($this->realPath);
      $this->path = trim(dirname($this->queryPath), '/');
    }
    else {
      $this->file = null;
      $this->extension = null;
      $this->dir  = null;
    }

    if($this->path == '.') {
      $this->path = null;
    }

    $this->breadcrumb = empty($this->path) ? array() : explode('/', $this->path);

    //echo "<pre>" . print_r($this, 1) . "</pre>";

    // Check that dir lies below securedir
    $this->message = null;
    $msg = "<p><i>WARNING: The path you have selected is not a valid path or restricted due to security constraints.</i></p>";
    if(substr_compare($this->secureDir, $this->dir, 0, strlen($this->secureDir))) {
      $this->file = null;
      $this->extension = null;
      $this->dir  = null;
      $this->message = $msg;
    }

    // Check that all parts of the path is valid items
    foreach($this->breadcrumb as $val) {
      if(in_array($val, $this->ignore)) {
        $this->file = null;
        $this->extension = null;
        $this->dir  = null;
        $this->message = $msg;
        break;
      }
    }

  }



  /**
   * List the sourcecode.
   */
  public function View() {
    return $this->GetBreadcrumbFromPath() 
      . $this->message . $this->ReadCurrentDir() . $this->GetFileContent();
  }



  /**
   * Create a breadcrumb of the current dir and path.
   */
  public function GetBreadcrumbFromPath() {

    $html  = "<ul class='src-breadcrumb'>\n";
    $html .= "<li><a href='?'>" . basename($this->baseDir) . "</a>/</li>";
    $path = null; 
    foreach($this->breadcrumb as $val) {
      $path .= "$val/";      
      $html .= "<li><a href='?path={$path}'>{$val}</a>/</li>";
    }
    $html .= "</ul>\n";

    return $html;
  }



  /**
   * Read all files of the current directory.
   */
  public function ReadCurrentDir() {

    if(!$this->dir) return;

    $html = "<ul class='src-filelist'>";
    foreach(glob($this->dir . '/{*,.?*}', GLOB_MARK | GLOB_BRACE) as $val) {

      if(in_array(basename($val), $this->ignore)) {
        continue;
      }

      $file = basename($val) . (is_dir($val) ? '/' : null);
      $path = (empty($this->path) ? null : $this->path . '/') . $file;
      $html .= "<li><a href='?path={$path}'>{$file}</a></li>\n";
    }
    $html .= "</ul>\n";

    return $html;
  }



  /**
   * Get the details such as encoding and line endings from the file.
   */
  public function DetectFileDetails() {

    $this->encoding = null;

    // Detect character encoding
    if(function_exists('mb_detect_encoding')) {
      if($res = mb_detect_encoding($this->content, "auto, ISO-8859-1", true)) {
        $this->encoding = $res;
      }   
    }

    // Is it BOM?
    if(substr($this->content, 0, 3) == chr(0xEF) . chr(0xBB) . chr(0xBF)) {
      $this->encoding .= " BOM";
    }
    
    // Checking style of line-endings
    $this->lineendings = null;
    if(isset($this->encoding)) {
      $lines = explode("\n", $this->content);
      $l = strlen($lines[0]);
      
      if(substr($lines[0], $l-1, 1) == "\r") {
        $this->lineendings = " Windows (CRLF) ";
      } 
      /*elseif(substr($lines[0], $l-1, 1) == "\r") {
        $this->lineendings = " Mac (xxxx) ";
      } */
      else {
        $this->lineendings = " Unix (LF) ";    
      }
    }
    
  }


  
  /**
   * Remove passwords from known files from all files starting with config*.
   */
  public function FilterPasswords() {

    $pattern = array(
      '/(\'|")(DB_PASSWORD|DB_USER)(.+)/',
      '/\$(password|passwd|pwd|pw)(.+)/i',
    );


    $message = "Intentionally removed by CSource";
    $replace = array(
      '\1\2\1,  "' . $message . '");',
      '$\1 = "' . $message . '";',
    );

    /*
    $file = 'config';
    if (!strncmp($file, $this->file, strlen($file))) {
      $this->content = preg_replace($pattern, $replace, $this->content);
    }
    */

    $this->content = preg_replace($pattern, $replace, $this->content);
  }



  /**
   * Get the content of the file and format it.
   */
  public function GetFileContent() {

    if(!isset($this->file)) {
      return;
    }

    $this->content = file_get_contents($this->realPath);
    $this->DetectFileDetails();
    $this->FilterPasswords();

    // Display svg-image or enable link to display svg-image.
    $linkToDisplaySvg = "";
    if($this->extension == 'svg') {
      if(isset($_GET['displaysvg'])) {
        header("Content-type: image/svg+xml");
        echo $this->content;
        exit;   
      } else {
        $linkToDisplaySvg = "<a href='{$_SERVER['REQUEST_URI']}&displaysvg'>Display as SVG</a>";
      }
    }
    
    // Display image if a valid image file
    if(in_array($this->extension, $this->validImageExtensions)) {

      $baseDir = !empty($this->options['base_dir']) 
        ? rtrim($this->options['base_dir'], '/') . '/' 
        : null;
      $this->content = "<div style='overflow:auto;'><img src='{$baseDir}{$this->path}/{$this->file}' alt='[image not found]'></div>";

    } 
    
    // Display file content and format for a syntax
    else {
      $this->content = str_replace('  ', $this->spaces, $this->content);
      $this->content = highlight_string($this->content, true);
      $i=0;
      $rownums = "";
      $text = "";
      $a = explode('<br />', $this->content);   

      foreach($a as $row) {
        $i++;
        $rownums .= "<code><a id='L{$i}' href='#L{$i}'>{$i}</a></code><br />";
        $text .= $row . '<br />';
      }

      $this->content = <<< EOD
<div class='src-container'>
<div class='src-header'><code>{$i} lines {$this->encoding} {$this->lineendings} {$linkToDisplaySvg}</code></div>
<div class='src-rows'>{$rownums}</div>
<div class='src-code'>{$text}</div>
</div>
EOD;
    } 

    return "<h3 id='file'><code><a href='#file'>{$this->file}</a></code></h3>{$this->content}";
  }


}




/**
 * Do it.
 *
 */
$source = new CSource();
$content = $source->View();
?><!doctype html>
<html lang='en'>
<meta charset='utf-8' />
<title>View sourceode</title>
<meta name="robots" content="noindex" />
<meta name="robots" content="noarchive" />
<meta name="robots" content="nofollow" />
<style>
/**
 * Style for source.php
 */
.src-breadcrumb,
.src-filelist {
  font-family: monospace;
  list-style-type: none;
  padding: 0;
  margin: 0 0 22px 0;
}

.src-breadcrumb li {
  padding: 0;
  margin: 0;
  display: inline;
}

.src-container {
  min-width: 40em;
}

.src-header {
  color: #000;
  border: solid 1px #999;
  border-bottom: 0px;
  background: #eee;
  padding: 0.5em 0.5em 0.5em 0.5em;
} 

.src-rows {
  float: left;
  text-align: right;
  color: #999;
  border: solid 1px #999;
  border-right: none;
  background: #eee;
  padding: 0.5em 0.5em 0.5em 0.5em;
} 

.src-rows a:link,
.src-rows a:visited,
.src-rows a:hover,
.src-rows a:active  { 
  text-decoration: none; 
  color: inherit;
}

.src-code {
  white-space: nowrap;
  border: solid 1px #999;
  background: #f9f9f9;
  padding: 0.5em 0.5em 0.5em 0.5em;
  overflow: auto;
}
</style>
<body>
<h1>View sourcecode</h1>
<p>
The following files exists in this folder. Click to view.
</p>
<?=$content?>