api.php

<?php
/*
    Part-DB Version 0.4+ "nextgen"
    Copyright (C) 2017 Jan Böhmer
    https://github.com/jbtronics

    This program is free software; you can redistribute it and/or
    modify it under the terms of the GNU General Public License
    as published by the Free Software Foundation; either version 2
    of the License, or (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
*/

include_once('start_session.php');

use PartDB\AttachmentType;
use PartDB\Category;
use PartDB\Database;
use PartDB\Device;
use PartDB\Footprint;
use PartDB\Log;
use PartDB\Manufacturer;
use PartDB\Part;
use PartDB\Storelocation;
use PartDB\Supplier;
use PartDB\Tools\SystemVersion;
use PartDB\User;

$app = new Slim\App();
$database           = new Database();
$log                = new Log($database);
$current_user       = User::getLoggedInUser(); // admin


/**
 * Creates a error message
 * @param \Slim\Http\Response $response The existing response object.
 * @param string|array $message The message of the error.
 * @param int $code The HTTP error code of the error.
 * @param Exception|array $exception An Exception that happened
 * @return \Slim\Http\Response The updated response Object
 */
function generateError($response, $message = "", $code = 500, $exception = null)
{
    if ($message != "") {
        $error = array("message" => $message);
    }
    if ($exception != null) {
        $error = array("message" => $exception->getMessage());
    }

    return $response->withJson(array("code" => $code, "errors" => array($error)), $code);
}

function generateTreeForClass($class, &$database, &$current_user, &$log, $params = null, $page = "", $key = "")
{
    try {
        $root_id = (isset($params['root_id']) && $params['root_id'] >= 0) ? $params['root_id'] : 0;
        /** @var \PartDB\Base\StructuralDBElement $root */
        /** @var \PartDB\Base\DBElement $class */
        $root = $class::getInstance($database, $current_user, $log, $root_id);
        if (isset($params['page']) && isset($params['parameter'])) {
            return $root->buildBootstrapTree($params['page'], $params['parameter']);
        } else {
            return $root->buildBootstrapTree($page, $key);
        }
    } catch (Exception $ex) {
        debug("error", $ex);
    }
    return null;
}


/********************************************************************
 * Category
 ********************************************************************/
$app->get("/1.0.0/categories/{cid}", function ($request, $response, $args) use (&$database, &$log, &$current_user) {
    /** @var \Slim\Http\Response $response */
    if ($args['cid'] < 1) {
        return generateError($response, "The id must be greater 0!", 400);
    }
    try {
        $category = Category::getInstance($database, $current_user, $log, (int) $args['cid']);
        return $response->withJson($category->getAPIArray(true));
    } catch (Exception $ex) {
        return generateError($response, "", 500, $ex);
    }
});


/********************************************************************
 * Storelocation
 ********************************************************************/

$app->get("/1.0.0/locations/{lid}", function ($request, $response, $args) use (&$database, &$log, &$current_user) {
    /** @var \Slim\Http\Response $response */
    if ($args['lid'] < 1) {
        return generateError($response, "The id must be greater 0!", 400);
    }
    try {
        $loc = Storelocation::getInstance($database, $current_user, $log, (int) $args['lid']);
        return $response->withJson($loc->getAPIArray(true));
    } catch (Exception $ex) {
        return generateError($response, "", 500, $ex);
    }
});

/********************************************************************
 * Manufacturer
 ********************************************************************/

$app->get("/1.0.0/manufacturers/{id}", function ($request, $response, $args) use (&$database, &$log, &$current_user) {
    /** @var \Slim\Http\Response $response */
    if ($args['id'] < 1) {
        return generateError($response, "The id must be greater 0!", 400);
    }
    try {
        $man = Manufacturer::getInstance($database, $current_user, $log, (int) $args['id']);
        return $response->withJson($man->getAPIArray(true));
    } catch (Exception $ex) {
        return generateError($response, "", 500, $ex);
    }
});

/********************************************************************
 * Suppliers
 ********************************************************************/

$app->get("/1.0.0/suppliers/{id}", function ($request, $response, $args) use (&$database, &$log, &$current_user) {
    /** @var \Slim\Http\Response $response */
    if ($args['id'] < 1) {
        return generateError($response, "The id must be greater 0!", 400);
    }
    try {
        $sup = Supplier::getInstance($database, $current_user, $log, (int) $args['id']);
        return $response->withJson($sup->getAPIArray(true));
    } catch (Exception $ex) {
        return generateError($response, "", 500, $ex);
    }
});

/********************************************************************
 * Attachement Types
 ********************************************************************/

$app->get("/1.0.0/attachmenttypes/{id}", function ($request, $response, $args) use (&$database, &$log, &$current_user) {
    /** @var \Slim\Http\Response $response */
    if ($args['id'] < 1) {
        return generateError($response, "The id must be greater 0!", 400);
    }
    try {
        $at = AttachmentType::getInstance($database, $current_user, $log, (int) $args['id']);
        return $response->withJson($at->getAPIArray(true));
    } catch (Exception $ex) {
        return generateError($response, "", 500, $ex);
    }
});

/********************************************************************
 * Footprints
 ********************************************************************/

$app->get("/1.0.0/footprints/{id}", function ($request, $response, $args) use (&$database, &$log, &$current_user) {
    /** @var \Slim\Http\Response $response */
    if ($args['id'] < 1) {
        return generateError($response, "The id must be greater 0!", 400);
    }
    try {
        $foot = Footprint::getInstance($database, $current_user, $log, (int) $args['id']);
        return $response->withJson($foot->getAPIArray(true));
    } catch (Exception $ex) {
        return generateError($response, "", 500, $ex);
    }
});

/********************************************************************
 * Parts
 ********************************************************************/

$app->get("/1.0.0/parts", function ($request, $response, $args) use (&$database, &$log, &$current_user) {
    /** @var \Slim\Http\Response $response */
    try {
        $parts = Part::getAllParts($database, $current_user, $log);
        return $response->withJson(convertAPIModelArray($parts));
    } catch (Exception $ex) {
        return generateError($response, "", 500, $ex);
    }
});

$app->get("/1.0.0/parts/noprice", function ($request, $response, $args) use (&$database, &$log, &$current_user) {
    /** @var \Slim\Http\Response $response */
    try {
        $parts = Part::getNoPriceParts($database, $current_user, $log);
        return $response->withJson(convertAPIModelArray($parts));
    } catch (Exception $ex) {
        return generateError($response, "", 500, $ex);
    }
});

$app->get("/1.0.0/parts/ordered", function ($request, $response, $args) use (&$database, &$log, &$current_user) {
    /** @var \Slim\Http\Response $response */
    try {
        $parts = Part::getOrderParts($database, $current_user, $log);
        return $response->withJson(convertAPIModelArray($parts));
    } catch (Exception $ex) {
        return generateError($response, "", 500, $ex);
    }
});

$app->get("/1.0.0/parts/obsolete", function ($request, $response, $args) use (&$database, &$log, &$current_user) {
    /** @var \Slim\Http\Response $response */
    try {
        $parts = Part::getObsoleteParts($database, $current_user, $log);
        return $response->withJson(convertAPIModelArray($parts));
    } catch (Exception $ex) {
        return generateError($response, "", 500, $ex);
    }
});

$app->get("/1.0.0/parts/{id}", function ($request, $response, $args) use (&$database, &$log, &$current_user) {
    /** @var \Slim\Http\Response $response */
    if ($args['id'] < 1) {
        return generateError($response, "The id must be greater 0!", 400);
    }
    try {
        $part = Part::getInstance($database, $current_user, $log, (int) $args['id']);
        return $response->withJson($part->getAPIArray(true));
    } catch (Exception $ex) {
        return generateError($response, "", 500, $ex);
    }
});

$app->get("/1.0.0/parts/by-category/{id}", function ($request, $response, $args) use (&$database, &$log, &$current_user) {
    /** @var \Slim\Http\Response $response */
    if ($args['id'] < 1) {
        return generateError($response, "The id must be greater 0!", 400);
    }
    try {
        $recursive = (isset($args['recursive'])) ?  $args['recursive'] : false;
        $category = Category::getInstance($database, $current_user, $log, (int) $args['id']);
        $parts = $category->getParts($recursive);
        return $response->withJson(convertAPIModelArray($parts));
    } catch (Exception $ex) {
        return generateError($response, "", 500, $ex);
    }
});

$app->get("/1.0.0/parts/by-location/{id}", function ($request, $response, $args) use (&$database, &$log, &$current_user) {
    /** @var \Slim\Http\Response $response */
    if ($args['id'] < 1) {
        return generateError($response, "The id must be greater 0!", 400);
    }
    try {
        $recursive = (isset($args['recursive'])) ?  $args['recursive'] : false;
        $location = Storelocation::getInstance($database, $current_user, $log, (int) $args['id']);
        $parts = $location->getParts($recursive);
        return $response->withJson(convertAPIModelArray($parts));
    } catch (Exception $ex) {
        return generateError($response, "", 500, $ex);
    }
});

$app->get("/1.0.0/parts/by-footprint/{id}", function ($request, $response, $args) use (&$database, &$log, &$current_user) {
    /** @var \Slim\Http\Response $response */
    if ($args['id'] < 1) {
        return generateError($response, "The id must be greater 0!", 400);
    }
    try {
        $recursive = (isset($args['recursive'])) ?  $args['recursive'] : false;
        $footprint = Footprint::getInstance($database, $current_user, $log, (int) $args['id']);
        $parts = $footprint->getParts($recursive);
        return $response->withJson(convertAPIModelArray($parts));
    } catch (Exception $ex) {
        return generateError($response, "", 500, $ex);
    }
});

$app->get("/1.0.0/parts/by-manufacturer/{id}", function ($request, $response, $args) use (&$database, &$log, &$current_user) {
    /** @var \Slim\Http\Response $response */
    if ($args['id'] < 1) {
        return generateError($response, "The id must be greater 0!", 400);
    }
    try {
        $recursive = (isset($args['recursive'])) ?  $args['recursive'] : false;
        $manufacturer = Manufacturer::getInstance($database, $current_user, $log, (int) $args['id']);
        $parts = $manufacturer->getParts($recursive);
        return $response->withJson(convertAPIModelArray($parts));
    } catch (Exception $ex) {
        return generateError($response, "", 500, $ex);
    }
});

$app->get("/1.0.0/parts/by-supplier/{id}", function ($request, $response, $args) use (&$database, &$log, &$current_user) {
    /** @var \Slim\Http\Response $response */
    if ($args['id'] < 1) {
        return generateError($response, "The id must be greater 0!", 400);
    }
    try {
        $recursive = (isset($args['recursive'])) ?  $args['recursive'] : false;
        $supplier = Supplier::getInstance($database, $current_user, $log, (int) $args['id']);
        $parts = $supplier->getParts($recursive);
        return $response->withJson(convertAPIModelArray($parts));
    } catch (Exception $ex) {
        return generateError($response, "", 500, $ex);
    }
});

$app->get("/1.0.0/parts/by-keyword/{keyword}", function ($request, $response, $args) use (&$database, &$log, &$current_user) {
    /** @var \Slim\Http\Response $response */
    try {
        $keyword = trim($args['keyword']);
        $keyword = trim($keyword, '"');
        $parts = Part::searchParts(
            $database,
            $current_user,
            $log,
            $keyword,
            $args['groupby'] ?? "",
            $args['name'] ?? true,
            $args['description'] ?? true,
            $args['comment'] ?? false,
            $args['footprint'] ?? false,
            $args['category'] ?? false,
            $args['location'] ?? false,
            $args['supplier'] ?? false,
            $args['partnr'] ?? false,
            $args['manufacturer'] ?? false,
            false
        );
        return $response->withJson(convertAPIModelArray($parts));
    } catch (Exception $ex) {
        return generateError($response, "", 500, $ex);
    }
});

$app->get("/1.0.0/parts/by-regex/{keyword}", function ($request, $response, $args) use (&$database, &$log, &$current_user) {
    /** @var \Slim\Http\Response $response */
    try {
        $keyword = trim($args['keyword']);
        $keyword = trim($keyword, '"');
        $parts = Part::searchParts(
            $database,
            $current_user,
            $log,
            $keyword,
            $args['groupby'] ?? "",
            $args['name'] ?? true,
            $args['description'] ?? true,
            $args['comment'] ??false,
            $args['footprint'] ?? false,
            $args['category'] ?? false,
            $args['location'] ?? false,
            $args['supplier'] ?? false,
            $args['partnr'] ?? false,
            $args['manufacturer'] ?? false,
            true
        );
        return $response->withJson(convertAPIModelArray($parts));
    } catch (Exception $ex) {
        return generateError($response, "", 500, $ex);
    }
});

/********************************************************************
 * System
 ********************************************************************/

/**
 * Get the system version
 */
$app->get("/1.0.0/system/info", function ($request, $response, $args) {
    /** @var \Slim\Http\Response $response */
    $ver_str = SystemVersion::getInstalledVersion()->asString();
    $data = array("version" => $ver_str,
        "gitBranch" => getGitBranchName(), "gitCommit" => getGitCommitHash());
    return $response->withJson($data);
});


/********************************************************************
 * Trees
 ********************************************************************/

/**
 * Get the tree for categories
 */
$app->get("/1.0.0/tree/categories[/{root_id}]", function ($request, $response, $args) use (&$database, &$log, &$current_user) {
    /** @var \Slim\Http\Response $response */
    try {
        $tree = generateTreeForClass(Category::class, $database, $current_user, $log, $args, "show_category_parts.php", "cid");
        return $response->withJson($tree);
    } catch (Exception $ex) {
        return generateError($response, "", 500, $ex);
    }
});

/**
 * Get the tree for categories
 */
$app->get("/1.0.0/tree/devices[/{root_id}]", function ($request, $response, $args) use (&$database, &$log, &$current_user) {
    /** @var \Slim\Http\Response $response */
    try {
        $root_device = Device::getInstance($database, $current_user, $log, 0);
        $tree = $root_device->buildBootstrapTree(
            "show_device_parts.php",
            "device_id",
            true,
            true,
            false,
            _("Übersicht")
        );
        return $response->withJson($tree);
    } catch (Exception $ex) {
        return generateError($response, "", 500, $ex);
    }
});

/**
 * Get the tree for categories
 */
$app->get("/1.0.0/tree/footprints[/{root_id}]", function ($request, $response, $args) use (&$database, &$log, &$current_user) {
    /** @var \Slim\Http\Response $response */
    try {
        $tree = generateTreeForClass(Footprint::class, $database, $current_user, $log, $args, "show_footprint_parts.php", "fid");
        return $response->withJson($tree);
    } catch (Exception $ex) {
        return generateError($response, "", 500, $ex);
    }
});

/**
 * Get the tree for storelocation
 */
$app->get("/1.0.0/tree/locations[/{root_id}]", function ($request, $response, $args) use (&$database, &$log, &$current_user) {
    /** @var \Slim\Http\Response $response */
    try {
        $tree = generateTreeForClass(Storelocation::class, $database, $current_user, $log, $args, "show_location_parts.php", "lid");
        return $response->withJson($tree);
    } catch (Exception $ex) {
        return generateError($response, "", 500, $ex);
    }
});

/**
 * Get the tree for manufacturer
 */
$app->get("/1.0.0/tree/manufacturers[/{root_id}]", function ($request, $response, $args) use (&$database, &$log, &$current_user) {
    /** @var \Slim\Http\Response $response */
    try {
        $tree = generateTreeForClass(Manufacturer::class, $database, $current_user, $log, $args, "show_manufacturer_parts.php", "mid");
        return $response->withJson($tree);
    } catch (Exception $ex) {
        return generateError($response, "", 500, $ex);
    }
});

/**
 * Get the tree for suppliers
 */
$app->get("/1.0.0/tree/suppliers[/{root_id}]", function ($request, $response, $args) use (&$database, &$log, &$current_user) {
    /** @var \Slim\Http\Response $response */
    try {
        $tree = generateTreeForClass(Supplier::class, $database, $current_user, $log, $args, "show_supplier_parts.php", "sid");
        return $response->withJson($tree);
    } catch (Exception $ex) {
        return generateError($response, "", 500, $ex);
    }
});

/**
 * Get the tree for tools
 */
$app->get("/1.0.0/tree/tools[/]", function ($request, $response, $args) {
    /** @var \Slim\Http\Response $response */
    try {
        $tree = buildToolsTree($args);
        return $response->withJson($tree);
    } catch (Exception $ex) {
        return generateError($response, "", 500, $ex);
    }
});

/**
 * Get the tree for tools
 */
$app->get("/1.0.0/3d_models/dir_tree[/]", function ($request, $response, $args) {
    /** @var \Slim\Http\Response $response */

    $dirs = array();

    try {
        $dirHandle = dir(BASE . "/models/");

        // Verzeichnis Datei für Datei lesen
        while (($f = $dirHandle->read()) != false) {
            // Nur ausgeben, wenn nicht . oder ..
            if ($f != "." && $f != "..") {
                // Wenn es sich um ein Verzeichnis handelt
                if (is_dir(BASE . "/models/".$f)) {
                    $dirs[] = treeviewNode($f, $f);
                }
            }
        }

        $nodes = array();
        $nodes[] = treeviewNode(_("Verzeichnisse"), "", $dirs);

        return $response->withJson($nodes);
    } catch (Exception $ex) {
        return generateError($response, "", 500, $ex);
    }
});

$app->get("/1.0.0/3d_models/files/{dir}[/]", function ($request, $response, $args) {
    /** @var \Slim\Http\Response $response */
    $items = array();
    try {
        $dir = $args["dir"];

        $files = findAllFiles(BASE . "/models/" . $dir . "/", true, ".x3d");
        foreach ($files as &$file) {
            $file = str_replace(BASE . "/models/" . $dir . "/", "", $file);
        }

        return $response->withJson($files);
    } catch (Exception $ex) {
        return generateError($response, "", 500, $ex);
    }
});

$app->get("/1.0.0/3d_models/files[/]", function ($request, $response, $args) {
    /** @var \Slim\Http\Response $response */
    $items = array();
    try {
        $files = findAllFiles(BASE . "/models/", true, ".x3d");
        foreach ($files as &$file) {
            $file = str_replace(BASE . "/models/", "", $file);
        }

        return $response->withJson($files);
    } catch (Exception $ex) {
        return generateError($response, "", 500, $ex);
    }
});

$app->get("/1.0.0/img_files/files[/]", function ($request, $response, $args) {
    /** @var \Slim\Http\Response $response */
    $items = array();
    try {
        $files = findAllFiles(BASE . "/img/footprints/", true);
        foreach ($files as &$file) {
            $file = str_replace(BASE . "/img/footprints/", "", $file);
        }

        return $response->withJson($files);
    } catch (Exception $ex) {
        return generateError($response, "", 500, $ex);
    }
});

$app->run();