mirror of
https://we.phorge.it/source/phorge.git
synced 2024-11-14 19:02:41 +01:00
182 lines
5.4 KiB
PHP
182 lines
5.4 KiB
PHP
|
<?php
|
||
|
|
||
|
/*
|
||
|
* Copyright 2011 Facebook, Inc.
|
||
|
*
|
||
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||
|
* you may not use this file except in compliance with the License.
|
||
|
* You may obtain a copy of the License at
|
||
|
*
|
||
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||
|
*
|
||
|
* Unless required by applicable law or agreed to in writing, software
|
||
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
||
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||
|
* See the License for the specific language governing permissions and
|
||
|
* limitations under the License.
|
||
|
*/
|
||
|
|
||
|
class PhabricatorConduitConsoleController
|
||
|
extends PhabricatorConduitController {
|
||
|
|
||
|
private $method;
|
||
|
|
||
|
public function willProcessRequest(array $data) {
|
||
|
$this->method = idx($data, 'method');
|
||
|
}
|
||
|
|
||
|
public function processRequest() {
|
||
|
$methods = $this->getAllMethods();
|
||
|
if (empty($methods[$this->method])) {
|
||
|
$this->method = key($methods);
|
||
|
}
|
||
|
|
||
|
$method_class = $methods[$this->method];
|
||
|
PhutilSymbolLoader::loadClass($method_class);
|
||
|
$method_object = newv($method_class, array());
|
||
|
|
||
|
|
||
|
$error_description = array();
|
||
|
$error_types = $method_object->defineErrorTypes();
|
||
|
if ($error_types) {
|
||
|
$error_description[] = '<ul>';
|
||
|
foreach ($error_types as $error => $meaning) {
|
||
|
$error_description[] =
|
||
|
'<li>'.
|
||
|
'<strong>'.phutil_escape_html($error).':</strong> '.
|
||
|
phutil_escape_html($meaning).
|
||
|
'</li>';
|
||
|
}
|
||
|
$error_description[] = '</ul>';
|
||
|
$error_description = implode("\n", $error_description);
|
||
|
} else {
|
||
|
$error_description = "This method does not raise any specific errors.";
|
||
|
}
|
||
|
|
||
|
$form = new AphrontFormView();
|
||
|
$form
|
||
|
->setAction('/api/'.$this->method)
|
||
|
->appendChild(
|
||
|
id(new AphrontFormStaticControl())
|
||
|
->setLabel('Description')
|
||
|
->setValue(
|
||
|
phutil_escape_html($method_object->getMethodDescription())))
|
||
|
->appendChild(
|
||
|
id(new AphrontFormStaticControl())
|
||
|
->setLabel('Returns')
|
||
|
->setValue(
|
||
|
phutil_escape_html($method_object->defineReturnType())))
|
||
|
->appendChild(
|
||
|
id(new AphrontFormStaticControl())
|
||
|
->setLabel('Errors')
|
||
|
->setValue($error_description))
|
||
|
->appendChild(
|
||
|
'<p class="aphront-form-instructions">Enter parameters using '.
|
||
|
'<strong>JSON</strong>. For instance, to enter a list, type: '.
|
||
|
'<tt>["apple", "banana", "cherry"]</tt>');
|
||
|
|
||
|
$params = $method_object->defineParamTypes();
|
||
|
foreach ($params as $param => $desc) {
|
||
|
$form->appendChild(
|
||
|
id(new AphrontFormTextControl())
|
||
|
->setLabel($param)
|
||
|
->setName("params[{$param}]")
|
||
|
->setCaption($desc));
|
||
|
}
|
||
|
|
||
|
$form
|
||
|
->appendChild(
|
||
|
id(new AphrontFormSelectControl())
|
||
|
->setLabel('Output Format')
|
||
|
->setName('output')
|
||
|
->setOptions(
|
||
|
array(
|
||
|
'human' => 'Human Readable',
|
||
|
'json' => 'JSON',
|
||
|
)))
|
||
|
->appendChild(
|
||
|
id(new AphrontFormSubmitControl())
|
||
|
->setValue('Call Method'));
|
||
|
|
||
|
$panel = new AphrontPanelView();
|
||
|
$panel->setHeader('Conduit API: '.phutil_escape_html($this->method));
|
||
|
$panel->appendChild($form);
|
||
|
$panel->setWidth(AphrontPanelView::WIDTH_WIDE);
|
||
|
|
||
|
$view = new AphrontSideNavView();
|
||
|
foreach ($this->buildNavItems() as $item) {
|
||
|
$view->addNavItem($item);
|
||
|
}
|
||
|
|
||
|
$view->appendChild($panel);
|
||
|
|
||
|
return $this->buildStandardPageResponse(
|
||
|
array($view),
|
||
|
array(
|
||
|
'title' => 'Conduit Console',
|
||
|
'tab' => 'console',
|
||
|
));
|
||
|
}
|
||
|
|
||
|
private function buildNavItems() {
|
||
|
$classes = $this->getAllMethodImplementationClasses();
|
||
|
$method_names = array();
|
||
|
foreach ($classes as $method_class) {
|
||
|
$method_name = ConduitAPIMethod::getAPIMethodNameFromClassName(
|
||
|
$method_class);
|
||
|
$method_names[] = array(
|
||
|
'full_name' => $method_name,
|
||
|
'group_name' => reset(explode('.', $method_name)),
|
||
|
);
|
||
|
}
|
||
|
$method_names = igroup($method_names, 'group_name');
|
||
|
ksort($method_names);
|
||
|
|
||
|
$items = array();
|
||
|
foreach ($method_names as $group => $methods) {
|
||
|
$items[] = phutil_render_tag(
|
||
|
'a',
|
||
|
array(
|
||
|
),
|
||
|
phutil_escape_html($group));
|
||
|
foreach ($methods as $method) {
|
||
|
$method_name = $method['full_name'];
|
||
|
$selected = ($method_name == $this->method);
|
||
|
$items[] = phutil_render_tag(
|
||
|
'a',
|
||
|
array(
|
||
|
'class' => $selected ? 'aphront-side-nav-selected' : null,
|
||
|
'href' => '/conduit/method/'.$method_name,
|
||
|
),
|
||
|
'<span style="padding-left: 1em;">'.
|
||
|
phutil_escape_html($method_name).
|
||
|
'</span>');
|
||
|
}
|
||
|
$items[] = '<hr />';
|
||
|
}
|
||
|
// Pop off the last '<hr />'.
|
||
|
array_pop($items);
|
||
|
|
||
|
return $items;
|
||
|
}
|
||
|
|
||
|
private function getAllMethods() {
|
||
|
$classes = $this->getAllMethodImplementationClasses();
|
||
|
$methods = array();
|
||
|
foreach ($classes as $class) {
|
||
|
$name = ConduitAPIMethod::getAPIMethodNameFromClassName($class);
|
||
|
$methods[$name] = $class;
|
||
|
}
|
||
|
return $methods;
|
||
|
}
|
||
|
|
||
|
private function getAllMethodImplementationClasses() {
|
||
|
$classes = id(new PhutilSymbolLoader())
|
||
|
->setAncestorClass('ConduitAPIMethod')
|
||
|
->setType('class')
|
||
|
->selectSymbolsWithoutLoading();
|
||
|
return array_values(ipull($classes, 'name'));
|
||
|
}
|
||
|
|
||
|
}
|