PHP Quickstart

 $(document).ready(function() {
        $("#connect").click(function() {

            $.ajax( {
                type: 'POST',                                            //POST request
                url: '/tutorial.php',                                    //url where tutorial is stored
                data: { url: $("#url").val(),
                    login : $("#login").val(),
                    password: $("#password").val(),
                    search: $('#search').val() } ,
                        success: function(data) {
                            var tutorialresults = $(data);
                            $("#results").append(tutorialresults);          //append Tutorial results

                }
            } );
   } );
} );

function start_session($ezdb) {

    $fields = array();                              //Initialize postfields array
    $postvars = make_postvars($fields);             //serialized the array to HTTP syntax

    $curlArr = curl_get($ezdb->new_session);        //call cURL get method, use new session url

    $ezdb->setToken($curlArr[1]);                   //Save token from the reponse body
    $ezdb->setContent($curlArr[1]);                 //Save response body
    $ezdb->setHeader($curlArr[0]);                  //Save response header
}

function retrieve_current_session($ezdb) {

    $token = $ezdb->token;
    $fields = array('token' = >$token);               //Initialize postfields array
    $postvars = make_postvars($fields);             //serialized the array to HTTP syntax

    $curlArr = curl_get($ezdb->new_session);        //call cURL get method, use new session url
}

function authenticate_session($ezdb, $login, $password) {

    $fields = array('token' = >$ezdb->token,
                    'password' = >$password,
                    'login' = >$login);                        //initialize postfields array with login credentials
    $postvars = make_postvars($fields);                      //serialize the array to HTTP syntax
    $curlArr = curl_post($ezdb->auth_session, $postvars);    //call cURL post method, use authenitcation url
}

function deauthenticate_session($ezdb) {

    $fields = array('token' = >$ezdb->token);                // Initialize postfields array
    $postvars = make_postvars($fields);                      // serialized the array to HTTP syntax

    $response = curl_post($ezdb->deauth_session, $postvars); // call cURL post method, use deauthenitcation url
}

<?php

//
//    CALL FROM POST REQUEST, WITH OR WITHOUT SEARCH CRITERIA
//

if (empty($_POST)) {
    echo makePostForm();
} else {
    if ( isset($_POST['search']) ) {
        main($_POST['url'], $_POST['login'], $_POST['password'], $_POST['search']);
    } else {
        main($_POST['url'], $_POST['login'], $_POST['password'], null);
    }
}

//
//    MAIN
//

function main($dbURL, $login, $password, $searchables) {

    $ezdb = new Session($dbURL, $searchables);

    if (!start_session($ezdb)) {
        echo "\r\ncould not start a session\r\n";
        return;
    }

    authenticate_session($ezdb, $login, $password);

    echo root_menu_about($ezdb);

    if ($searchables) {
        echo "<div class = 'container-fluid'><h3>Search Results</h1>";
        echo ( search($ezdb, $login, $password));
        echo "</div>";
    }
}

//
//    SESSION OBJECT
//

class Session {

    public function __construct($server, $searchable = null, $searchtype = null, $searchjson = null) {

        $http = "http://";
        if (strpos($server, $http) !== false) {
            $http = "";
        }
        $this->server = $http . $server;
        $this->new_session = $http . $server . "/api/v1/session";
        $this->auth_session = $http . $server . "/api/v1/session/authenticate";
        $this->deauth_session = $http . $server . "/api/v1/session/deauthenticate";
        $this->search = $http . $server . "/api/v1/search";
        $this->plugins = $http . $server . "/api/v1/plugin";
        $this->buildinfo = $http . $server . "/web/build_info.json";
        $this->searchable = $searchable;
        $this->searchtype = $searchtype;
        $this->searchjson = $searchjson;
        $this->token = 0;
        $this->content = 0;
        $this->header = 0;
    }

    public function setToken($response) {

        $jsonResponse = json_decode($response, true);
        if (!isset($jsonResponse['token'])) {
            echo "\r\ncould not find token in the response\r\n";
            return;
        }
        $this->token = $jsonResponse['token'];
    }

    public function setContent($response) {

        $jsonResponse = json_decode($response, true);
        $this->content = $jsonResponse;
    }

    public function setHeader($response) {

        $jsonResponse = json_decode($response, true);
        $this->header = $jsonResponse;
    }
}

//
//    HTTP REQUEST METHODS
//

function curl_post($url, $postvars, $searchCriteria = null) {

    $ch = curl_init();
    curl_setopt($ch, CURLOPT_URL, $url);
    curl_setopt($ch, CURLOPT_POST, 1); // post = 0 for a get request

    curl_setopt($ch, CURLOPT_POSTFIELDS, $postvars);

    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
    curl_setopt($ch, CURLOPT_CONNECTTIMEOUT , 3);
    curl_setopt($ch, CURLOPT_TIMEOUT, 20);

    if (!is_null($searchCriteria)) {
        curl_setopt($ch, CURLOPT_URL, $url ."?". $postvars);
        curl_setopt($ch, CURLOPT_HTTPHEADER, array(
            "Content-Length: ". strlen($searchCriteria) ,
            "Content-Type: application/json" ,
            "Accept: application/json"
        ));
        curl_setopt($ch, CURLOPT_POSTFIELDS, ($searchCriteria));
    } else {
        curl_setopt($ch, CURLOPT_HEADER, 1);
    }

    $response = curl_exec($ch);
    $header_size = curl_getinfo($ch, CURLINFO_HEADER_SIZE);
    $header = substr($response, 0, $header_size);
    $body = substr($response, $header_size);

    if (!is_null($searchCriteria)) {
        return $response;
    }
    print_curl_information($ch);
    curl_close ($ch);
    return array($header, $body);
}

function curl_get($url, $getvars = null) {

    $ch = curl_init();
    curl_setopt($ch, CURLOPT_URL, $url);
    curl_setopt($ch, CURLOPT_POST, 0); // post = 0 for a get request

    if (!is_null($getvars)) {
        curl_setopt($ch, CURLOPT_GETFIELDS, $getvars);
    }

    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
    curl_setopt($ch, CURLOPT_CONNECTTIMEOUT , 3);
    curl_setopt($ch, CURLOPT_TIMEOUT, 20);
    curl_setopt($ch, CURLOPT_HEADER, 1);
    $response = curl_exec($ch);

    $header_size = curl_getinfo($ch, CURLINFO_HEADER_SIZE);
    $header = substr($response, 0, $header_size);
    $body = substr($response, $header_size);
    print_curl_information($ch);
    curl_close ($ch);

    return array($header, $body);
}

//
//    TUTORIAL METHODS
//

function start_session($ezdb) {

    $fields = array();
    $postvars = make_postvars($fields);

    $curlArr = curl_get($ezdb->new_session);

    if (!is_null($curlArr) && sizeof($curlArr) > 0) {
        $ezdb->setToken($curlArr[1]);
        $ezdb->setContent($curlArr[1]);
        $ezdb->setHeader($curlArr[0]);

        return true;
    }

    return false;
}

function retrieve_current_session($ezdb) {

    $token = $ezdb->token;
    $fields = array('token' => $token);
    $postvars = make_postvars($fields);

    $curlArr = curl_get($ezdb->new_session);
}

function authenticate_session($ezdb, $login, $password) {

    $fields = array('token' => $ezdb->token, 'password' => $password, 'login' => $login);
    $postvars = make_postvars($fields);
    $curlArr = curl_post($ezdb->auth_session, $postvars);
}

function deauthenticate_session($ezdb) {

    $fields = array('token' => $ezdb->token);
    $postvars = make_postvars($fields);

    $response = curl_post($ezdb->deauth_session, $postvars);
}

function search($ezdb, $login, $password) {

    // making the search criteria
    $searchables = explode(", ", $ezdb->searchable);
    $jsonencodedsearchablesyntax = array();
    foreach($searchables as $s) {
        $arr = array('phrase' => false, 'bool' => 'must', 'mode' => 'fulltext', 'string' => $s, 'type' => 'match');
        array_push($jsonencodedsearchablesyntax, $arr);
    }

    $fields = array('token' => $ezdb->token);
    $jsonencodedsearchablesyntax = json_encode(array('search' => $jsonencodedsearchablesyntax) );
    $postvars = make_postvars($fields);
    $curlArr = curl_post($ezdb->search, $postvars, $jsonencodedsearchablesyntax );

    $curlArr = json_decode($curlArr, true);

    $result = "<p>";
    $count = 0;

    if (!is_null($curlArr)) {

        $basenames = (array_value_recursive('original_filename', $curlArr));
        $originalnames = array_value_recursive('name', $curlArr);

        if (is_array($basenames)) {
            foreach($basenames as $bn) {
                $result .= $bn . "<br>";
                $count ++;
            }
        }
        if (is_array($originalnames)) {
            foreach($originalnames as $on) {
                $result .= $on . "<br>";
                $count ++;
            }
        }
    }

    $result .= "Total Count : " . $count  . "<br>";
    $result .= "</p>";
    return  $result;
}

function root_menu_about($ezdb) {

    $aboutDetails = array("api" , "server_version" , "user-schema" , "solution" , "instance", "db-name", "Plugins", "server", "Build", '5 git', 'CUi git');
    $outputArray = [];
    $buildinfo = get_build_info($ezdb);

    foreach($aboutDetails as $element) {

        if ($element == "instance") {
            $element = "name";
        }
        else if ($element == "Plugins") {
            $info = getPlugins($ezdb); }
        else if ($element == "server") {
            $info = $ezdb->server;
        }
        else if ($element == "last-modified") {
            $info = $ezdb->header["last-modified"];
        }
        else if ($element == "Build") {
            $info = gmdate("Y-m-d\TH:i:s\Z", $buildinfo["date"] ). "  @". $buildinfo["host"];
        }
        else if ($element == "5 git") {
            $info = $buildinfo["ez5"];
        }
        else if ($element == "CUi git") {
            $info = $buildinfo["cui"];
        }
        else if (isset($ezdb->content['instance'][$element])) {
            $info = $ezdb->content['instance'][$element];
        }
        else {
            $info = "";
        }
        array_push($outputArray, array("About" => $element, "Information" => $info));
    }

    return outputTabel($outputArray);
}

//
//    HELPER FUNCTIONS
//

function getPlugins($ezdb) {

    $curlArr = curl_get($ezdb->plugins);
    $plugins = json_decode($curlArr[1], true);

    if (!isset($plugins['plugins'])) {
        return "";
    }

    $plugins = $plugins['plugins'];
    $plgnstring = "";
    foreach ($plugins as $plgn) {
        $plgnstring .= $plgn['name'] . ", ";
    }
    return rtrim($plgnstring, ", ");
}

function get_build_info($ezdb) {

    $curlArr = curl_get($ezdb->buildinfo);
    $buildinfo = json_decode($curlArr[1], true);
    return $buildinfo;
}

function array_value_recursive($key, array $arr) {

    $val = array();
    array_walk_recursive($arr, function($v, $k) use($key, &$val) {
        if ($k == $key) array_push($val, $v);
    } );
    return count($val) > 1 ? $val : array_pop($val);
}

function outputTabel($data) {

    $outputTabelHTML = "";
    $outputTabelHTML .= '<table><thead><tr>';

    $outputTabelHTML .= '<th>' . 'About' . '</th>';
    $outputTabelHTML .= '<th>' . 'Information' . '</th>';

    $outputTabelHTML .= '</tr></thead><tbody>';

    foreach ($data as $row) {
        $outputTabelHTML .= '<tr>';
        $outputTabelHTML .= '<td>' . $row['About'] . '</td>';
        $outputTabelHTML .= '<td>' . $row['Information'] . '</td>';
        $outputTabelHTML .= '</tr>';
    }

    $outputTabelHTML .= '</tbody></table>';
    return $outputTabelHTML;
}

function print_curl_information($ch) {

    echo "\r\n" . curl_getinfo($ch, CURLINFO_HTTP_CODE);
}

function print_curl_information_verbose($ch) {

    if (!curl_errno($ch)) {
        $info = curl_getinfo($ch);
        echo 'Took ', $info['total_time'], ' seconds to send a request to ', $info['url'], "\n";
    }
    if (!curl_errno($ch)) {
        switch ($http_code = curl_getinfo($ch, CURLINFO_HTTP_CODE)) {
            case 200:  # OK
                echo $http_code;
            break;
            default:
                echo 'Unexpected HTTP code: ', $http_code, "\n";
        }
    } else {
        echo 'Curl error: ' . curl_error($ch);
        $info = curl_getinfo($ch);
        echo 'Took ', $info['total_time'], ' seconds to send a request to ', $info['url'], "\n";
    }
}

function make_postvars($fields) {

    $postvars = '';
    foreach($fields as $key => $value) {
        $postvars .= $key . " = " . $value . "&";
    }
    return substr($postvars, 0, -1);
}

function makePostForm() {

    $search = 'search';
    $form = '<!DOCTYPE html>
    <html lang = "en">
    <!-- Latest compiled and minified CSS -->
    <link rel = "stylesheet" href = "https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css" integrity = "sha384-BVYiiSIFeK1dGmJRAkycuHAHRg32OmUcww7on3RYdg4Va+PmSTsz/K68vbdEjh4u" crossorigin = "anonymous">
    <!-- Optional theme -->
    <link rel = "stylesheet" href = "https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap-theme.min.css" integrity = "sha384-rHyoN1iRsVXV4nD0JutlnGaslCJuC7uwjduW9SVrLvRYooPp2bWYgmgJQIXwl/Sp" crossorigin = "anonymous">
    <!-- Latest compiled and minified JavaScript -->
    <script src = "https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js" integrity = "sha384-Tc5IQib027qvyjSMfHjOMaLkfuWVxZxUPnCJA7l2mCWNIpG9mGCD8wGNIcPD7Txa" crossorigin = "anonymous"></script>
    <script src = "//ajax.googleapis.com/ajax/libs/jquery/1.11.0/jquery.min.js"></script>

    <style>
    input[type = text], select, textarea {
        width: 100%; /* Full width */
        padding: 12px; /* Some padding */
        border: 1px solid #ccc; /* Gray border */
        border-radius: 4px; /* Rounded borders */
        box-sizing: border-box; /* Make sure that padding and width stays in place */
        margin-top: 6px; /* Add a top margin */
        margin-bottom: 16px; /* Bottom margin */
        resize: vertical /* Allow the user to vertically resize the textarea (not horizontally) */
    }

    input[type = submit] {
        background-color: #00BFFF;
        color: white;
        padding: 12px 20px;
        border: none;
        border-radius: 4px;
        cursor: pointer;
    }

    input[type = submit]:hover {
        background-color: #00addd;
    }

    .container {
        border-radius: 5px;
        background-color: #f2f2f2;
        padding: 20px;
    }
    </style><div class = "container-fluid">
    <form action = "/tutorial.php" method = "post">

    <label for = "url">easydb URL</label>
    <input type = "text" id = "url" name = "url" placeholder = "http://5.easydb.de">

    <label for = "login">LOGIN</label>
    <input type = "text" id = "login" name = "login" placeholder = "username/email..">

    <label for = "password">PASS</label>
    <input type = "text" id = "password" name = "password" placeholder = "password..">

    <label for = "search">Search</label>
    <input type = "text" id = "search" name = "search"  placeholder = "*optional*" />

    <input type = "submit" value = "RUN"></form></div></html>';

    return $form;
}

//    error_message

function server_url_error_message($str, $err) {

    echo "URL is invalid";
    echo " {0} raises {1} ".format($str, $err);
}

function command_line_error_message() {

    echo "Value must be entered in for -server and -search or -searchjson";
    echo "Please run again";
}

function search_criteria_error_message() {

    echo "input search criteria does not exist";
    echo "please check for spelling errors or move file closer to session.py directory";
}

function doNothing($e) {

    //doing nothing
    echo "<script>console.log('doing nothing!');</script>";
}

?>