Merge pull request #2 from plugowski/feature/snippets

Feature/snippets

Author: plugowski

README.md

@@ -8,7 +8,15 @@ Simple and usefull tool to execute custom php scripts. It allows to block specif
 
 ## Installation
 
-Clone that repository wherever you want (in my example `/www/php_sandbox`), then in base dir run:
+Clone that repository wherever you want (in my example `/www/php_sandbox`)
+
+```
+$ cd /www
+$ git clone git@github.com:plugowski/php_sandbox.git 
+```
+
+and load all dependencies:
+
 
 ```
 composer update --no-dev
@@ -57,6 +65,13 @@ Ctrl-S | Command-S | Execute code
 
 ## Changelog
 
+- 1.2
+  - fixed counting of memory used by script (now it is counting only for evaluated script without extra stuff from bootstrap)
+  - added new PhpStorm shortcut
+  - changed routing from FatFree to my own (FatFree fired couple ini_sets which might conflict with security settings, where  
+  ini_set() function will be disabled)
+  - added snippets, which you can save and load in any time
+  - added possibility to switch between couple of php versions
 - 1.1
   - added Kint debug tool for dumping varialbles
   - refactored Config class

src/Evaluator/Snippet.php

@@ -0,0 +1,194 @@
+<?php
+namespace PhpSandbox\Evaluator;
+
+/**
+ * Class Snippet
+ * @package Evaluator
+ */
+class Snippet
+{
+    /**
+     * @var Config
+     */
+    private $config;
+
+    /**
+     * Snippet constructor.
+     * @param Config $config
+     */
+    public function __construct(Config $config)
+    {
+        $this->config = $config;
+    }
+
+    /**
+     * @param string|null $subFolder
+     * @return string
+     */
+    private function getSnippetsDir($subFolder = null)
+    {
+        $dir = $this->config->read('snippets_dir');
+
+        if (!is_null($subFolder)) {
+            $dir .= DIRECTORY_SEPARATOR . $subFolder;
+        }
+
+        if (!file_exists($dir)) {
+            mkdir($dir, 0755, true);
+        }
+        return $dir;
+    }
+
+    /**
+     * Validate name of created snippet
+     *
+     * @param string $name
+     * @throws SnippetException
+     */
+    private function validateName($name)
+    {
+        if (substr_count($name, '/') > 1) {
+            throw new SnippetException("Only one level of folders are allowed.", SnippetException::MAX_NESTING);
+        }
+        if (!preg_match('/^(\w+\/)?[\w\.]+$/', $name)) {
+            throw new SnippetException("Name contains not allowed characters!", SnippetException::WRONG_NAME);
+        }
+        if (false === strpos($name, '.php')) {
+            throw new SnippetException("Extension is required and should be *.php", SnippetException::MISSING_EXTENSION);
+        }
+    }
+
+    /**
+     * Save posted code into snippet
+     *
+     * @param string $name
+     * @param string $code
+     * @return bool
+     */
+    public function save($name, $code)
+    {
+        $this->validateName($name);
+
+        $dir = null;
+        if (false !== strpos($name, '/')) {
+            list($dir, $name) = explode('/', $name);
+        }
+
+        $fh = fopen($this->getSnippetsDir($dir) . DIRECTORY_SEPARATOR . $name, 'w+');
+        fwrite($fh, $code);
+        fclose($fh);
+
+        return true;
+    }
+
+    /**
+     * Return snippet content
+     *
+     * @param array $params
+     */
+    public function load($params)
+    {
+        $fullName = $this->getSnippetsDir() . $params['filename'];
+
+        if (file_exists($fullName)) {
+            $code = file_get_contents($fullName);
+        }
+
+        echo json_encode(compact('code'));
+    }
+
+    /**
+     * Delete snippet
+     *
+     * @param array $params
+     * @throws SnippetException
+     * @return bool
+     */
+    public function delete($params)
+    {
+        $fullName = $this->getSnippetsDir() . $params['filename'];
+
+        if (!file_exists($fullName)) {
+            throw new SnippetException("File does not exists!", SnippetException::FILE_NOT_EXISTS);
+        }
+        if (!is_writable($fullName)) {
+            throw new SnippetException("No permission to modify file!", SnippetException::NO_PERMISSION);
+        }
+
+        unlink($fullName);
+
+        $parts = explode('/', $fullName);
+        array_pop($parts);
+        $dir = implode('/', $parts);
+
+        // if dir is empty, remove it
+        if (count(scandir($dir)) == 2) {
+            rmdir($dir);
+        }
+
+        return true;
+    }
+
+    /**
+     * Return list of all snippets
+     *
+     * @return array
+     */
+    public function getList()
+    {
+        $files = $this->recursiveScan($this->getSnippetsDir());
+        return $this->prepareArrayToJson($files);
+    }
+
+    /**
+     * Build JSON with structure of folders and files
+     *
+     * @param $files
+     * @return array
+     */
+    private function prepareArrayToJson($files)
+    {
+        $tmp = [];
+        foreach ($files as $k => $value) {
+
+            $name = $value;
+            $type = 'file';
+            $data = [];
+
+            if (preg_match('/^>\s/', $k)) {
+                $type = 'folder';
+                $name = str_replace('> ', '', $k);
+                $data = $this->prepareArrayToJson($value);
+            }
+
+            $tmp[] = ['name' => $name, 'type' => $type, 'data' => $data];
+        }
+        return $tmp;
+    }
+
+    /**
+     * Recursive scan selected folder and list all files and folders
+     *
+     * @param string $dir
+     * @return array
+     */
+    private function recursiveScan($dir)
+    {
+        $files = scandir($dir);
+        $tmp = [];
+
+        foreach ($files as $file) {
+            if (in_array($file, ['.', '..'])) {
+                continue;
+            }
+
+            if (is_dir($dir . DIRECTORY_SEPARATOR . $file)) {
+                $tmp['> ' . $file] = $this->recursiveScan($dir . DIRECTORY_SEPARATOR . $file);
+            } else {
+                $tmp[] = $file;
+            }
+        }
+        ksort($tmp);
+        return $tmp;
+    }
+}

src/Evaluator/SnippetException.php

@@ -0,0 +1,28 @@
+<?php
+namespace PhpSandbox\Evaluator;
+
+use Exception;
+
+/**
+ * Class SnippetException
+ * @package Evaluator
+ */
+class SnippetException extends Exception
+{
+    const MAX_NESTING = 1001;
+    const WRONG_NAME = 1002;
+    const MISSING_EXTENSION = 1003;
+    const FILE_NOT_EXISTS = 1004;
+    const NO_PERMISSION = 1005;
+
+    /**
+     * SnippetException constructor.
+     * @param string $message
+     * @param int $code
+     * @param Exception $previous
+     */
+    public function __construct($message = "", $code = 0, Exception $previous = null)
+    {
+        parent::__construct($message, $code, $previous);
+    }
+}

src/config.php

@@ -23,6 +23,11 @@
      */
     'tmp_dir' => '/tmp/php_sandbox/',
 
+    /**
+     * Dir where all snippets will be stored
+     */
+    'snippets_dir' => '/tmp/php_sandbox/snippets/',
+
     /**
      * Pre-execute scripts
      */

webroot/actions.php

@@ -8,6 +8,8 @@
 use PhpRouter\RouteRequest;
 use PhpSandbox\Evaluator\Config;
 use PhpSandbox\Evaluator\Evaluator;
+use PhpSandbox\Evaluator\Snippet;
+use PhpSandbox\Evaluator\SnippetException;
 
 // load config file
 $config = new Config(__DIR__ . '/../src/config.php');
@@ -51,6 +53,32 @@
     }
 }));
 
+/**
+ * Validate and save new snippet
+ */
+$routing->attach(new Route('POST /save_snippet.json [ajax]', function() use ($config){
+
+    if (!empty($_POST['name']) && !empty($_POST['code'])) {
+        try {
+            (new Snippet($config))->save($_POST['name'], $_POST['code']);
+            echo json_encode(['status' => 'success']);
+        } catch (SnippetException $e) {
+            echo json_encode(['status' => 'error', 'message' => $e->getMessage()]);
+        }
+    }
+}));
+
+/**
+ * Get snippets list
+ */
+$routing->attach(new Route('GET  /get_snippets_list.json', function() use ($config) {
+    $snippets = (new Snippet($config))->getList();
+    echo json_encode($snippets);
+}));
+
+$routing->attach(new Route('GET  /get_snippet/@filename', ['filename' => '[/\w]+.php'], '\PhpSandbox\Evaluator\Snippet->load', [$config]));
+$routing->attach(new Route('DELETE  /delete_snippet/@filename', ['filename' => '[/\w]+.php'], '\PhpSandbox\Evaluator\Snippet->delete', [$config]));
+
 /**
  * Get snippets list
  */