Server : ApacheSystem : Linux host.digitalbabaji.in 4.18.0-513.11.1.el8_9.x86_64 #1 SMP Wed Jan 17 02:00:40 EST 2024 x86_64 User : addictionfreeind ( 1003) PHP Version : 7.2.34 Disable Function : exec,passthru,shell_exec,system Directory : /home/addictionfreeind/public_html/admin1/vendor/froiden/laravel-rest-api/src/ |
Upload File : |
<?php
namespace Froiden\RestAPI;
use Froiden\RestAPI\Exceptions\Parse\NotAllowedToFilterOnThisFieldException;
use Froiden\RestAPI\Exceptions\ResourceNotFoundException;
use Froiden\RestAPI\Tests\Models\DummyUser;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Collection;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\BelongsTo;
use Froiden\RestAPI\ExtendedRelations\BelongsToMany;
use Illuminate\Database\Eloquent\Relations\HasMany;
use Illuminate\Database\Eloquent\Relations\HasOne;
use Illuminate\Database\Eloquent\Relations\Relation;
use Illuminate\Foundation\Http\FormRequest;
use Illuminate\Support\Arr;
use Illuminate\Support\Str;
class ApiController extends \Illuminate\Routing\Controller
{
/**
* Full class reference to model this controller represents
*
* @var string
*/
protected $model = null;
/**
* Table name corresponding to the model this controller is handling
*
* @var string
*/
private $table = null;
/**
* Primary key of the model
*
* @var string
*/
private $primaryKey = null;
/**
* Default number of records to return
*
* @var int
*/
protected $defaultLimit = 10;
/**
* Maximum number of recorded allowed to be returned in single request
*
* @var int
*/
protected $maxLimit = 1000;
/**
* Query being built to fetch the results
*
* @var Builder
*/
private $query = null;
/**
* Form request to validate index request
*
* @var FormRequest
*/
protected $indexRequest = null;
/**
* Form request to validate store request
*
* @var FormRequest
*/
protected $storeRequest = null;
/**
* Form request to validate show request
*
* @var FormRequest
*/
protected $showRequest = null;
/**
* Form request to validate update request
*
* @var FormRequest
*/
protected $updateRequest = null;
/**
* Form request to validate delete request
*
* @var FormRequest
*/
protected $deleteRequest = null;
/**
* Time when processing of this request started. Used
* to measure total processing time
*
* @var float
*/
private $processingStartTime = 0;
/**
* Fields to be excluded while saving a request. Fields not in excluded list
* are considered model attributes
*
* @var array
*/
protected $exclude = ["_token"];
/**
* @var RequestParser
*/
private $parser = null;
protected $results = null;
public function __construct()
{
$this->processingStartTime = microtime(true);
if ($this->model) {
// Only if model is defined. Otherwise, this is a normal controller
$this->primaryKey = call_user_func([new $this->model(), "getKeyName"]);
$this->table = call_user_func([new $this->model(), "getTable"]);
}
if (config('app.debug') == true) {
\DB::enableQueryLog();
}
}
/**
* Process index page request
*
* @return mixed
*/
public function index()
{
$this->validate();
$results = $this->parseRequest()
->addIncludes()
->addFilters()
->addOrdering()
->addPaging()
->modify()
->getResults()
->toArray();
$meta = $this->getMetaData();
return ApiResponse::make(null, $results, $meta);
}
/**
* Process the show request
*
* @return mixed
*/
public function show(...$args)
{
// We need to do this in order to support multiple parameter resource routes. For example,
// if we map route /user/{user}/comments/{comment} to a controller, Laravel will pass `user`
// as first argument and `comment` as last argument. So, id object that we want to fetch
// is the last argument.
$id = last(func_get_args());
$this->validate();
$results = $this->parseRequest()
->addIncludes()
->addKeyConstraint($id)
->modify()
->getResults(true)
->first()
->toArray();
$meta = $this->getMetaData(true);
return ApiResponse::make(null, $results, $meta);
}
public function store()
{
\DB::beginTransaction();
$this->validate();
// Create new object
/** @var ApiModel $object */
$object = new $this->model();
$object->fill(request()->all());
// Run hook if exists
if(method_exists($this, 'storing')) {
$object = call_user_func([$this, 'storing'], $object);
}
$object->save();
$meta = $this->getMetaData(true);
\DB::commit();
if(method_exists($this, 'stored')) {
call_user_func([$this, 'stored'], $object);
}
return ApiResponse::make("Resource created successfully", [ "id" => $object->id ], $meta);
}
public function update(...$args)
{
\DB::beginTransaction();
$id = last(func_get_args());
$this->validate();
// Get object for update
$this->query = call_user_func($this->model . "::query");
$this->modify();
/** @var ApiModel $object */
$object = $this->query->find($id);
if (!$object) {
throw new ResourceNotFoundException();
}
$object->fill(request()->all());
if(method_exists($this, 'updating')) {
$object = call_user_func([$this, 'updating'], $object);
}
$object->save();
$meta = $this->getMetaData(true);
\DB::commit();
if(method_exists($this, 'updated')) {
call_user_func([$this, 'updated'], $object);
}
return ApiResponse::make("Resource updated successfully", [ "id" => $object->id ], $meta);
}
public function destroy(...$args)
{
\DB::beginTransaction();
$id = last(func_get_args());
$this->validate();
// Get object for update
$this->query = call_user_func($this->model . "::query");
$this->modify();
/** @var Model $object */
$object = $this->query->find($id);
if (!$object) {
throw new ResourceNotFoundException();
}
if(method_exists($this, 'destroying')) {
$object = call_user_func([$this, 'destroying'], $object);
}
$object->delete();
$meta = $this->getMetaData(true);
\DB::commit();
if(method_exists($this, 'destroyed')) {
call_user_func([$this, 'destroyed'], $object);
}
return ApiResponse::make("Resource deleted successfully", null, $meta);
}
public function relation($id, $relation)
{
$this->validate();
// To show relations, we just make a new fields parameter, which requests
// only object id, and the relation and get the results like normal index request
$fields = "id," . $relation . ".limit(" . ((request()->limit) ? request()->limit : $this->defaultLimit) .
")" . ((request()->offset) ? ".offset(" . request()->offset . ")": "" )
. ((request()->fields) ? "{" .request()->fields . "}" : "");
request()->fields = $fields;
$results = $this->parseRequest()
->addIncludes()
->addKeyConstraint($id)
->modify()
->getResults(true)
->first()
->toArray();
$data = $results[$relation];
$meta = $this->getMetaData(true);
return ApiResponse::make(null, $data, $meta);
}
protected function parseRequest()
{
$this->parser = new RequestParser($this->model);
return $this;
}
protected function validate()
{
if ($this->isIndex()) {
$requestClass = $this->indexRequest;
}
else if ($this->isShow()) {
$requestClass = $this->showRequest;
}
else if ($this->isUpdate()) {
$requestClass = $this->updateRequest;
}
else if ($this->isDelete()) {
$requestClass = $this->deleteRequest;
}
else if ($this->isStore()) {
$requestClass = $this->storeRequest;
}
else if ($this->isRelation()) {
$requestClass = $this->indexRequest;
}
else {
$requestClass = null;
}
if ($requestClass) {
// We just make the class, its validation is called automatically
app()->make($requestClass);
}
}
/**
* Looks for relations in the requested fields and adds with query for them
*
* @return $this current controller object for chain method calling
*/
protected function addIncludes()
{
$relations = $this->parser->getRelations();
if (!empty($relations)) {
$includes = [];
foreach ($relations as $key => $relation) {
$includes[$key] = function (Relation $q) use ($relation, $key) {
$relations = $this->parser->getRelations();
$tableName = $q->getRelated()->getTable();
$primaryKey = $q->getRelated()->getKeyName();
if ($relation["userSpecifiedFields"]) {
// Prefix table name so that we do not get ambiguous column errors
$fields = $relation["fields"];
}
else {
// Add default fields, if no fields specified
$related = $q->getRelated();
$fields = call_user_func(get_class($related) . "::getDefaultFields");
$fields = array_merge($fields, $relation["fields"]);
$relations[$key]["fields"] = $fields;
}
// Remove appends from select
$appends = call_user_func(get_class($q->getRelated()) . "::getAppendFields");
$relations[$key]["appends"] = $appends;
if (!in_array($primaryKey, $fields)) {
$fields[] = $primaryKey;
}
$fields = array_map(function($name) use($tableName) {
return $tableName . "." . $name;
}, array_diff($fields, $appends));
if ($q instanceof BelongsToMany) {
// Because laravel loads all the related models of relations in many-to-many
// together, limit and offset do not work. So, we have to complicate things
// to make them work
$innerQuery = $q->getQuery();
$innerQuery->select($fields);
$innerQuery->selectRaw("@currcount := IF(@currvalue = " . $q->getQualifiedForeignPivotKeyName() . ", @currcount + 1, 1) AS rank");
$innerQuery->selectRaw("@currvalue := " . $q->getQualifiedForeignPivotKeyName() . " AS whatever");
$innerQuery->orderBy($q->getQualifiedForeignPivotKeyName(), ($relation["order"] == "chronological") ? "ASC" : "DESC");
// Inner Join causes issues when a relation for parent does not exist.
// So, we change it to right join for this query
$innerQuery->getQuery()->joins[0]->type = "right";
$outerQuery = $q->newPivotStatement();
$outerQuery->from(\DB::raw("(". $innerQuery->toSql() . ") as `$tableName`"))
->mergeBindings($innerQuery->getQuery());
$q->select($fields)
->join(\DB::raw("(" . $outerQuery->toSql() . ") as `outer_query`"), function ($join) use($q) {
$join->on("outer_query." . $q->getRelatedKeyName(), "=", $q->getQualifiedRelatedPivotKeyName ());
$join->on("outer_query.whatever", "=", $q->getQualifiedForeignPivotKeyName());
})
->setBindings(array_merge($q->getQuery()->getBindings(), $outerQuery->getBindings()))
->where("rank", "<=", $relation["limit"] + $relation["offset"])
->where("rank", ">", $relation["offset"]);
}
else {
// We need to select foreign key so that Laravel can match to which records these
// need to be attached
if ($q instanceof BelongsTo) {
$fields[] = $q->getOwnerKeyName();
if (strpos($key, ".") !== false) {
$parts = explode(".", $key);
array_pop($parts);
$relation["limit"] = $relations[implode(".", $parts)]["limit"];
}
}
else if ($q instanceof HasOne) {
$fields[] = $q->getQualifiedForeignKeyName();
// This will be used to hide this foreign key field
// in the processAppends function later
$relations[$key]["foreign"] = $q->getQualifiedForeignKeyName();
}
else if ($q instanceof HasMany) {
$fields[] = $q->getQualifiedForeignKeyName();
$relations[$key]["foreign"] = $q->getQualifiedForeignKeyName();
$q->orderBy($primaryKey, ($relation["order"] == "chronological") ? "ASC" : "DESC");
}
$q->select($fields);
$q->take($relation["limit"]);
if ($relation["offset"] !== 0) {
$q->skip($relation["offset"]);
}
}
$this->parser->setRelations($relations);
};
}
$this->query = call_user_func($this->model."::with", $includes);
}
else {
$this->query = call_user_func($this->model."::query");
}
return $this;
}
/**
* Add requested filters. Filters are defined similar to normal SQL queries like
* (name eq "Milk" or name eq "Eggs") and price lt 2.55
* The string should be enclosed in double quotes
* @return $this
* @throws NotAllowedToFilterOnThisFieldException
*/
protected function addFilters()
{
if ($this->parser->getFilters()) {
$this->query->whereRaw($this->parser->getFilters());
}
return $this;
}
/**
* Add sorting to the query. Sorting is similar to SQL queries
*
* @return $this
*/
protected function addOrdering()
{
if ($this->parser->getOrder()) {
$this->query->orderByRaw($this->parser->getOrder());
}
return $this;
}
/**
* Adds paging limit and offset to SQL query
*
* @return $this
*/
protected function addPaging()
{
$limit = $this->parser->getLimit();
$offset = $this->parser->getOffset();
if ($offset <= 0) {
$skip = 0;
}
else {
$skip = $offset;
}
$this->query->skip($skip);
$this->query->take($limit);
return $this;
}
protected function addKeyConstraint($id)
{
// Add equality constraint
$this->query->where($this->table . "." . ($this->primaryKey), "=", $id);
return $this;
}
/**
* Runs query and fetches results
*
* @param bool $single
* @return Collection
* @throws ResourceNotFoundException
*/
protected function getResults($single = false)
{
$customAttributes = call_user_func($this->model."::getAppendFields");
// Laravel's $appends adds attributes always to the output. With this method,
// we can specify which attributes are to be included
$appends = [];
$fields = $this->parser->getFields();
foreach ($fields as $key => $field) {
if (in_array($field, $customAttributes)) {
$appends[] = $field;
unset($fields[$key]);
}
else {
// Add table name to fields to prevent ambiguous column issues
$fields[$key] = $this->table . "." . $field;
}
}
$this->parser->setFields($fields);
if (!$single) {
/** @var Collection $results */
$results = $this->query->select($fields)->get();
}
else {
/** @var Collection $results */
$results = $this->query->select($fields)->skip(0)->take(1)->get();
if ($results->count() == 0) {
throw new ResourceNotFoundException();
}
}
foreach($results as $result) {
$result->setAppends($appends);
}
$this->processAppends($results);
$this->results = $results;
return $results;
}
private function processAppends($models, $parent = null)
{
if (! ($models instanceof Collection)) {
return $models;
}
else if ($models->count() == 0) {
return $models;
}
// Attribute at $key is a relation
$first = $models->first();
$attributeKeys = array_keys($first->getRelations());
$relations = $this->parser->getRelations();
foreach ($attributeKeys as $key) {
$relationName = ($parent === null) ? $key : $parent . "." . $key;
if (isset($relations[$relationName])) {
$appends = $relations[$relationName]["appends"];
$appends = array_intersect($appends, $relations[$relationName]["fields"]);
if (isset($relations[$relationName]["foreign"])) {
$foreign = explode(".", $relations[$relationName]["foreign"])[1];
}
else {
$foreign = null;
}
foreach ($models as $model) {
if ($model->$key instanceof Collection) {
$model->{$key}->each(function ($item, $key) use($appends, $foreign) {
$item->setAppends($appends);
// Hide the foreign key fields
if (!empty($foreign)) {
$item->makeHidden($foreign);
}
});
$this->processAppends($model->$key, $key);
}
else if (!empty($model->$key)) {
$model->$key->setAppends($appends);
if (!empty($foreign)) {
$model->$key->makeHidden($foreign);
}
$this->processAppends(collect($model->$key), $key);
}
}
}
}
}
/**
* Builds metadata - paging, links, time to complete request, etc
*
* @return array
*/
protected function getMetaData($single = false)
{
if (!$single) {
$meta = [
"paging" => [
"links" => [
]
]
];
$limit = $this->parser->getLimit();
$pageOffset = $this->parser->getOffset();
$current = $pageOffset;
// Remove offset because setting offset does not return
// result. As, there is single result in count query,
// and setting offset will not return that record
$offset = $this->query->getQuery()->offset;
$this->query->offset(0);
$totalRecords = $this->query->count($this->table . "." . $this->primaryKey);
$this->query->offset($offset);
$meta["paging"]["total"] = $totalRecords;
if (($current + $limit) < $meta["paging"]["total"]) {
$meta["paging"]["links"]["next"] = $this->getNextLink();
}
if ($current >= $limit) {
$meta["paging"]["links"]["previous"] = $this->getPreviousLink();
}
}
$meta["time"] = round(microtime(true) - $this->processingStartTime, 3);
if (config('app.debug') == true) {
$log = \DB::getQueryLog();
\DB::disableQueryLog();
$meta["queries"] = count($log);
$meta["queries_list"] = $log;
}
return $meta;
}
protected function getPreviousLink()
{
$offset = $this->parser->getOffset();
$limit = $this->parser->getLimit();
$queryString = ((request()->fields) ? "&fields=" . urlencode(request()->fields) : "") .
((request()->filters) ? "&filters=" . urlencode(request()->filters) : "") .
((request()->order) ? "&fields=" . urlencode(request()->order) : "");
$queryString .= "&offset=" . ($offset - $limit);
return request()->url() . "?" . trim($queryString, "&");
}
protected function getNextLink()
{
$offset = $this->parser->getOffset();
$limit = $this->parser->getLimit();
$queryString = ((request()->fields) ? "&fields=" . urlencode(request()->fields) : "") .
((request()->filters) ? "&filters=" . urlencode(request()->filters) : "") .
((request()->order) ? "&fields=" . urlencode(request()->order) : "");
$queryString .= "&offset=" . ($offset + $limit);
return request()->url() . "?" . trim($queryString, "&");
}
/**
* Checks if current request is index request
* @return bool
*/
protected function isIndex()
{
return in_array("index", explode(".", request()->route()->getName()));
}
/**
* Checks if current request is create request
* @return bool
*/
protected function isCreate()
{
return in_array("create", explode(".", request()->route()->getName()));
}
/**
* Checks if current request is show request
* @return bool
*/
protected function isShow()
{
return in_array("show", explode(".", request()->route()->getName()));
}
/**
* Checks if current request is update request
* @return bool
*/
protected function isUpdate()
{
return in_array("update", explode(".", request()->route()->getName()));
}
/**
* Checks if current request is delete request
* @return bool
*/
protected function isDelete()
{
return in_array("destroy", explode(".", request()->route()->getName()));
}
/**
* Checks if current request is store request
* @return bool
*/
protected function isStore()
{
return in_array("store", explode(".", request()->route()->getName()));
}
/**
* Checks if current request is relation request
* @return bool
*/
protected function isRelation()
{
return in_array("relation", explode(".", request()->route()->getName()));
}
/**
* Calls the modifyRequestType methods to modify query just before execution
* @return $this
*/
private function modify()
{
if ($this->isIndex()) {
$this->query = $this->modifyIndex($this->query);
}
else if ($this->isShow()) {
$this->query = $this->modifyShow($this->query);
}
else if ($this->isDelete()) {
$this->query = $this->modifyDelete($this->query);
}
else if ($this->isUpdate()) {
$this->query = $this->modifyUpdate($this->query);
}
return $this;
}
/**
* Modify the query for show request
* @param $query
* @return mixed
*/
protected function modifyShow($query)
{
return $query;
}
/**
* Modify the query for update request
* @param $query
* @return mixed
*/
protected function modifyUpdate($query)
{
return $query;
}
/**
* Modify the query for delete request
* @param $query
* @return mixed
*/
protected function modifyDelete($query)
{
return $query;
}
/**
* Modify the query for index request
* @param $query
* @return mixed
*/
protected function modifyIndex($query)
{
return $query;
}
protected function getQuery() {
return $this->query;
}
protected function setQuery($query) {
$this->query = $query;
}
//endregion
}