AS1024/Kanboard-Prod
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add first draft of the user api

Browse Source
This commit is contained in:
Frederic Guillot
2015-07-29 17:42:48 -04:00
parent 2eeb58ae03
commit f595fb2786
22 changed files with 763 additions and 78 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
app/Api/Action.php
View File

@@ -8,7 +8,7 @@ namespace Api;
* @package api
* @author Frederic Guillot
*/
class Action extends Base
class Action extends \Core\Base
{
public function getAvailableActions()
{

2
app/Api/App.php
View File

@@ -8,7 +8,7 @@ namespace Api;
* @package api
* @author Frederic Guillot
*/
class App extends Base
class App extends \Core\Base
{
public function getTimezone()
{

40
app/Api/Auth.php Normal file
View File

@@ -0,0 +1,40 @@
<?php
namespace Api;
use JsonRPC\AuthenticationFailure;
use Symfony\Component\EventDispatcher\Event;
/**
* Base class
*
* @package api
* @author Frederic Guillot
*/
class Auth extends Base
{
/**
* Check api credentials
*
* @access public
* @param string $username
* @param string $password
* @param string $class
* @param string $method
*/
public function checkCredentials($username, $password, $class, $method)
{
$this->container['dispatcher']->dispatch('api.bootstrap', new Event);
if ($username !== 'jsonrpc' && $this->authentication->authenticate($username, $password)) {
$this->checkProcedurePermission(true, $method);
$this->userSession->refresh($this->user->getByUsername($username));
}
else if ($username === 'jsonrpc' && $password === $this->config->get('api_token')) {
$this->checkProcedurePermission(false, $method);
}
else {
throw new AuthenticationFailure('Wrong credentials');
}
}
}

106
app/Api/Base.php
View File

@@ -3,7 +3,7 @@
namespace Api;
use JsonRPC\AuthenticationFailure;
use Symfony\Component\EventDispatcher\Event;
use JsonRPC\AccessDeniedException;
/**
* Base class
@@ -13,21 +13,97 @@ use Symfony\Component\EventDispatcher\Event;
*/
abstract class Base extends \Core\Base
{
/**
* Check api credentials
*
* @access public
* @param string $username
* @param string $password
* @param string $class
* @param string $method
*/
public function authentication($username, $password, $class, $method)
{
$this->container['dispatcher']->dispatch('api.bootstrap', new Event);
private $user_allowed_procedures = array(
'getMe',
'getMyDashboard',
'getMyActivityStream',
'createMyPrivateProject',
'getMyProjectsList',
);
if (! ($username === 'jsonrpc' && $password === $this->config->get('api_token'))) {
throw new AuthenticationFailure('Wrong credentials');
private $both_allowed_procedures = array(
'getTimezone',
'getVersion',
'getProjectById',
'getTask',
'getTaskByReference',
'getAllTasks',
'openTask',
'closeTask',
'moveTaskPosition',
'createTask',
'updateTask',
'getBoard',
);
public function checkProcedurePermission($is_user, $procedure)
{
$is_both_procedure = in_array($procedure, $this->both_allowed_procedures);
$is_user_procedure = in_array($procedure, $this->user_allowed_procedures);
if ($is_user && ! $is_both_procedure && ! $is_user_procedure) {
throw new AccessDeniedException('Permission denied');
}
else if (! $is_user && ! $is_both_procedure && $is_user_procedure) {
throw new AccessDeniedException('Permission denied');
}
}
public function checkProjectPermission($project_id)
{
if ($this->userSession->isLogged() && ! $this->projectPermission->isUserAllowed($project_id, $this->userSession->getId())) {
throw new AccessDeniedException('Permission denied');
}
}
public function checkTaskPermission($task_id)
{
if ($this->userSession->isLogged()) {
$this->checkProjectPermission($this->taskFinder->getProjectId($task_id));
}
}
protected function formatTask($task)
{
if (! empty($task)) {
$task['url'] = $this->helper->url->to('task', 'show', array('task_id' => $task['id'], 'project_id' => $task['project_id']), '', true);
}
return $task;
}
protected function formatTasks($tasks)
{
if (! empty($tasks)) {
foreach ($tasks as &$task) {
$task = $this->formatTask($task);
}
}
return $tasks;
}
protected function formatProject($project)
{
if (! empty($project)) {
$project['url'] = array(
'board' => $this->helper->url->to('board', 'show', array('project_id' => $project['id']), '', true),
'calendar' => $this->helper->url->to('calendar', 'show', array('project_id' => $project['id']), '', true),
'list' => $this->helper->url->to('listing', 'show', array('project_id' => $project['id']), '', true),
);
}
return $project;
}
protected function formatProjects($projects)
{
if (! empty($projects)) {
foreach ($projects as &$project) {
$project = $this->formatProject($project);
}
}
return $projects;
}
}

1
app/Api/Board.php
View File

@@ -12,6 +12,7 @@ class Board extends Base
{
public function getBoard($project_id)
{
$this->checkProjectPermission($project_id);
return $this->board->getBoard($project_id);
}

2
app/Api/Category.php
View File

@@ -8,7 +8,7 @@ namespace Api;
* @package api
* @author Frederic Guillot
*/
class Category extends Base
class Category extends \Core\Base
{
public function getCategory($category_id)
{

2
app/Api/Comment.php
View File

@@ -8,7 +8,7 @@ namespace Api;
* @package api
* @author Frederic Guillot
*/
class Comment extends Base
class Comment extends \Core\Base
{
public function getComment($comment_id)
{

2
app/Api/File.php
View File

@@ -8,7 +8,7 @@ namespace Api;
* @package api
* @author Frederic Guillot
*/
class File extends Base
class File extends \Core\Base
{
public function getFile($file_id)
{

2
app/Api/Link.php
View File

@@ -8,7 +8,7 @@ namespace Api;
* @package api
* @author Frederic Guillot
*/
class Link extends Base
class Link extends \Core\Base
{
/**
* Get a link by id

55
app/Api/Me.php Normal file
View File

@@ -0,0 +1,55 @@
<?php
namespace Api;
use Model\Subtask as SubtaskModel;
use Model\Task as TaskModel;
/**
* Me API controller
*
* @package api
* @author Frederic Guillot
*/
class Me extends Base
{
public function getMe()
{
return $this->session['user'];
}
public function getMyDashboard()
{
$user_id = $this->userSession->getId();
$projects = $this->project->getQueryColumnStats($this->projectPermission->getActiveMemberProjectIds($user_id))->findAll();
$tasks = $this->taskFinder->getUserQuery($user_id)->findAll();
return array(
'projects' => $this->formatProjects($projects),
'tasks' => $this->formatTasks($tasks),
'subtasks' => $this->subtask->getUserQuery($user_id, array(SubTaskModel::STATUS_TODO, SubtaskModel::STATUS_INPROGRESS))->findAll(),
);
}
public function getMyActivityStream()
{
return $this->projectActivity->getProjects($this->projectPermission->getActiveMemberProjectIds($this->userSession->getId()), 100);
}
public function createMyPrivateProject($name, $description = null)
{
$values = array(
'name' => $name,
'description' => $description,
'is_private' => 1,
);
list($valid,) = $this->project->validateCreation($values);
return $valid ? $this->project->create($values, $this->userSession->getId(), true) : false;
}
public function getMyProjectsList()
{
return $this->projectPermission->getMemberProjects($this->userSession->getId());
}
}

25
app/Api/Project.php
View File

@@ -12,6 +12,7 @@ class Project extends Base
{
public function getProjectById($project_id)
{
$this->checkProjectPermission($project_id);
return $this->formatProject($this->project->getById($project_id));
}
@@ -82,28 +83,4 @@ class Project extends Base
list($valid,) = $this->project->validateModification($values);
return $valid && $this->project->update($values);
}
private function formatProject($project)
{
if (! empty($project)) {
$project['url'] = array(
'board' => $this->helper->url->to('board', 'show', array('project_id' => $project['id']), '', true),
'calendar' => $this->helper->url->to('calendar', 'show', array('project_id' => $project['id']), '', true),
'list' => $this->helper->url->to('listing', 'show', array('project_id' => $project['id']), '', true),
);
}
return $project;
}
private function formatProjects($projects)
{
if (! empty($projects)) {
foreach ($projects as &$project) {
$project = $this->formatProject($project);
}
}
return $projects;
}
}

2
app/Api/ProjectPermission.php
View File

@@ -8,7 +8,7 @@ namespace Api;
* @package api
* @author Frederic Guillot
*/
class ProjectPermission extends Base
class ProjectPermission extends \Core\Base
{
public function getMembers($project_id)
{

2
app/Api/Subtask.php
View File

@@ -8,7 +8,7 @@ namespace Api;
* @package api
* @author Frederic Guillot
*/
class Subtask extends Base
class Subtask extends \Core\Base
{
public function getSubtask($subtask_id)
{

2
app/Api/Swimlane.php
View File

@@ -8,7 +8,7 @@ namespace Api;
* @package api
* @author Frederic Guillot
*/
class Swimlane extends Base
class Swimlane extends \Core\Base
{
public function getActiveSwimlanes($project_id)
{

30
app/Api/Task.php
View File

@@ -14,16 +14,19 @@ class Task extends Base
{
public function getTask($task_id)
{
$this->checkTaskPermission($task_id);
return $this->formatTask($this->taskFinder->getById($task_id));
}
public function getTaskByReference($project_id, $reference)
{
$this->checkProjectPermission($project_id);
return $this->formatTask($this->taskFinder->getByReference($project_id, $reference));
}
public function getAllTasks($project_id, $status_id = TaskModel::STATUS_OPEN)
{
$this->checkProjectPermission($project_id);
return $this->formatTasks($this->taskFinder->getAll($project_id, $status_id));
}
@@ -34,11 +37,13 @@ class Task extends Base
public function openTask($task_id)
{
$this->checkTaskPermission($task_id);
return $this->taskStatus->open($task_id);
}
public function closeTask($task_id)
{
$this->checkTaskPermission($task_id);
return $this->taskStatus->close($task_id);
}
@@ -49,6 +54,7 @@ class Task extends Base
public function moveTaskPosition($project_id, $task_id, $column_id, $position, $swimlane_id = 0)
{
$this->checkProjectPermission($project_id);
return $this->taskPosition->movePosition($project_id, $task_id, $column_id, $position, $swimlane_id);
}
@@ -57,6 +63,8 @@ class Task extends Base
$recurrence_status = 0, $recurrence_trigger = 0, $recurrence_factor = 0, $recurrence_timeframe = 0,
$recurrence_basedate = 0, $reference = '')
{
$this->checkProjectPermission($project_id);
$values = array(
'title' => $title,
'project_id' => $project_id,
@@ -87,6 +95,8 @@ class Task extends Base
$recurrence_status = null, $recurrence_trigger = null, $recurrence_factor = null,
$recurrence_timeframe = null, $recurrence_basedate = null, $reference = null)
{
$this->checkTaskPermission($id);
$values = array(
'id' => $id,
'title' => $title,
@@ -115,24 +125,4 @@ class Task extends Base
list($valid) = $this->taskValidator->validateApiModification($values);
return $valid && $this->taskModification->update($values);
}
private function formatTask($task)
{
if (! empty($task)) {
$task['url'] = $this->helper->url->to('task', 'show', array('task_id' => $task['id'], 'project_id' => $task['project_id']), '', true);
}
return $task;
}
private function formatTasks($tasks)
{
if (! empty($tasks)) {
foreach ($tasks as &$task) {
$task = $this->formatTask($task);
}
}
return $tasks;
}
}

2
app/Api/TaskLink.php
View File

@@ -8,7 +8,7 @@ namespace Api;
* @package api
* @author Frederic Guillot
*/
class TaskLink extends Base
class TaskLink extends \Core\Base
{
/**
* Get a task link

2
app/Api/User.php
View File

@@ -10,7 +10,7 @@ use Auth\Ldap;
* @package api
* @author Frederic Guillot
*/
class User extends Base
class User extends \Core\Base
{
public function getUser($user_id)
{