init commit

plugins/xframework/common/Input.php

@@ -0,0 +1,118 @@
+<?php
+namespace XFramework;
+
+/**
+ * Roundcube Plus Framework plugin.
+ *
+ * This class retrieves request data sent by Angular ajax requests. Angular json-encodes the parameters and php doesn't
+ * decode them properly into $_POST, so we get the data and decode it manually.
+ *
+ * Copyright 2016, Tecorama LLC.
+ *
+ * @license Commercial. See the LICENSE file for details.
+ */
+
+require_once "Singleton.php";
+
+class Input
+{
+    use Singleton;
+    private array $data = [];
+
+    /**
+     * Gets all input data.
+     *
+     * @param bool $skipTokenCheck
+     * @return array
+     */
+    public function getAll(bool $skipTokenCheck = false): array
+    {
+        $this->init($skipTokenCheck);
+        return $this->data;
+    }
+
+    /**
+     * Get a variable from the post.
+     *
+     * @param string $key
+     * @param bool $skipTokenCheck
+     * @return mixed
+     */
+
+    public function get(string $key, bool $skipTokenCheck = false)
+    {
+        $this->init($skipTokenCheck);
+        return array_key_exists($key, $this->data) ? $this->data[$key] : "";
+    }
+
+    /**
+     * Check whether a variable exists in the post.
+     *
+     * @param string $key
+     * @param bool $skipTokenCheck
+     * @return boolean
+     */
+    public function has(string $key, bool $skipTokenCheck = false): bool
+    {
+        $this->init($skipTokenCheck);
+        return isset($this->data[$key]);
+    }
+
+    /**
+     * Fills an array with values from the POST. The array should contain a list of keys as values, the return will
+     * contain those keys as keys and values from post as values.
+     *
+     * @param array $fields
+     * @param bool $skipTokenCheck
+     * @return array
+     */
+    public function fill(array $fields, bool $skipTokenCheck = false): array
+    {
+        $this->init($skipTokenCheck);
+        $result = [];
+
+        foreach ($fields as $key) {
+            $result[$key] = array_key_exists($key, $this->data) ? $this->data[$key] : false;
+        }
+
+        return $result;
+    }
+
+    /**
+     * Checks the Roundcube token sent with the request.
+     * @codeCoverageIgnore
+     */
+    public function checkToken()
+    {
+        if (empty($_SERVER["HTTP_X_CSRF_TOKEN"]) || $_SERVER["HTTP_X_CSRF_TOKEN"] != xrc()->get_request_token()) {
+            http_response_code(403);
+            exit();
+        }
+    }
+
+    /**
+     * This is used for unit tesitng.
+     * @param array $data
+     * @codeCoverageIgnore
+     */
+    public function setData(array $data)
+    {
+        $this->data = $data;
+    }
+
+    /**
+     * Fills the data directly from the php input.
+     * @codeCoverageIgnore
+     */
+    protected function init($skipTokenCheck)
+    {
+        if (empty($this->data)) {
+            $data = json_decode(file_get_contents('php://input'), true);
+            $this->data = is_array($data) ? $data : [];
+
+            if (!$skipTokenCheck) {
+                $this->checkToken();
+            }
+        }
+    }
+}