natalie/indefero
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Added the first work on an API.

Browse Source
This commit is contained in:
Loic d'Anterroches
2008-11-21 20:33:39 +01:00
parent 0e725bea26
commit 9814a75f82
12 changed files with 305 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files

110
src/IDF/Views/Api.php Normal file
View File

@@ -0,0 +1,110 @@
<?php
/* -*- tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
# ***** BEGIN LICENSE BLOCK *****
# This file is part of InDefero, an open source project management application.
# Copyright (C) 2008 Céondo Ltd and contributors.
#
# InDefero 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.
#
# InDefero 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 St, Fifth Floor, Boston, MA 02110-1301 USA
#
# ***** END LICENSE BLOCK ***** */
/**
* API views.
*
* These are just small wrappers around the "normal" views. The normal
* views are called with a third parameters $api set to true to return
* JSON instead of HTML.
*
* A special precondition is used to set the $request->user from the
* _login, _hash and _salt parameters.
*/
class IDF_Views_Api
{
/**
* View list of issues for a given project.
*/
public $issuesIndex_precond = array('IDF_Precondition::apiSetUser',
'IDF_Precondition::accessIssues');
public function issuesIndex($request, $match)
{
$views = new IDF_Views_Issue();
$p = $views->index($request, $match, true);
$out = array(
'project' => $request->project->shortname,
'open' => $p['open'],
'closed' => $p['closed'],
'issues' => $p['issues']->render_array(),
);
return new Pluf_HTTP_Response_Json($out);
}
/**
* Create a new issue.
*/
public $issueCreate_precond = array('IDF_Precondition::apiSetUser',
'IDF_Precondition::accessIssues');
public function issueCreate($request, $match)
{
$views = new IDF_Views_Issue();
$p = $views->create($request, $match, true);
$out = array();
if ($request->method == 'GET') {
// We give the details of the form
$out['doc'] = 'A POST request against this url will allow you to create a new issue.';
if ($request->user->hasPerm('IDF.project-owner', $request->project)
or $request->user->hasPerm('IDF.project-member', $request->project)) {
$out['status'] = array();
foreach (self::getTags($request->project) as $tag) {
$out['status'][] = $tag->name;
}
}
} else {
// We need to give back the results of the creation
if (is_object($p) and 'IDF_Issue' == get_class($p)) {
$out['mess'] = 'success';
$out['issue'] = $p->id;
} else {
$out['mess'] = 'error';
$out['errors'] = $p['form']->errors;
}
}
return new Pluf_HTTP_Response_Json($out);
}
/**
* Get the list of tags to give them to the end users when doing a
* GET request against a form. That way it is possible for them to
* know which tags/labels are available.
*
* @param IDF_Project Current project
* @param string Which tags to get ('issue-open')
* @return ArrayObject Tags
*/
public static function getTags($project, $what='issue-open')
{
switch ($what) {
case 'issue-open':
$key = 'labels_issue_open';
$default = IDF_Form_IssueTrackingConf::init_open;
return $project->getTagsFromConfig($key, $default);
case 'issue-closed':
return $project->getTagIdsByStatus('closed');
}
return array();
}
}

38
src/IDF/Views/Issue.php
View File

@@ -35,7 +35,7 @@ class IDF_Views_Issue
* View list of issues for a given project.
*/
public $index_precond = array('IDF_Precondition::accessIssues');
public function index($request, $match)
public function index($request, $match, $api=false)
{
$prj = $request->project;
$title = sprintf(__('%s Open Issues'), (string) $prj);
@@ -65,15 +65,15 @@ class IDF_Views_Issue
$pag->items_per_page = 10;
$pag->no_results_text = __('No issues were found.');
$pag->setFromRequest($request);
$params = array('project' => $prj,
'page_title' => $title,
'open' => $open,
'closed' => $closed,
'issues' => $pag,
'cloud' => 'issues');
if ($api) return $params;
return Pluf_Shortcuts_RenderToResponse('idf/issues/index.html',
array('project' => $prj,
'page_title' => $title,
'open' => $open,
'closed' => $closed,
'issues' => $pag,
'cloud' => 'issues',
),
$request);
$params, $request);
}
/**
@@ -133,7 +133,7 @@ class IDF_Views_Issue
public $create_precond = array('IDF_Precondition::accessIssues',
'Pluf_Precondition::loginRequired');
public function create($request, $match)
public function create($request, $match, $api=false)
{
$prj = $request->project;
$title = __('Submit a new issue');
@@ -169,20 +169,22 @@ class IDF_Views_Issue
$email->addTextMessage($tmpl->render($context));
$email->sendMail();
}
if ($api) return $issue;
return new Pluf_HTTP_Response_Redirect($url);
}
} else {
$form = new IDF_Form_IssueCreate(null, $params);
}
$arrays = self::autoCompleteArrays($prj);
$params = array_merge(
array('project' => $prj,
'form' => $form,
'page_title' => $title,
),
self::autoCompleteArrays($prj)
);
if ($api == true) return $params;
return Pluf_Shortcuts_RenderToResponse('idf/issues/create.html',
array_merge(
array('project' => $prj,
'form' => $form,
'page_title' => $title,
),
$arrays),
$request);
$params, $request);
}
public $search_precond = array('IDF_Precondition::accessIssues');

4
src/IDF/Views/User.php
View File

@@ -38,6 +38,9 @@ class IDF_Views_User
public $myAccount_precond = array('Pluf_Precondition::loginRequired');
public function myAccount($request, $match)
{
// As the password is salted, we can directly take the sha1 of
// the salted password.
$api_key = sha1($request->user->password);
$params = array('user' => $request->user);
if ($request->method == 'POST') {
$form = new IDF_Form_UserAccount($request->POST, $params);
@@ -52,6 +55,7 @@ class IDF_Views_User
}
return Pluf_Shortcuts_RenderToResponse('idf/user/myaccount.html',
array('page_title' => __('Your Account'),
'api_key' => $api_key,
'form' => $form),
$request);
}