425 lines
12 KiB
PHP
425 lines
12 KiB
PHP
<?php
|
|
/**
|
|
* PHPCI - Continuous Integration for PHP
|
|
*
|
|
* @copyright Copyright 2014, Block 8 Limited.
|
|
* @license https://github.com/Block8/PHPCI/blob/master/LICENSE.md
|
|
* @link https://www.phptesting.org/
|
|
*/
|
|
|
|
namespace PHPCI\Controller;
|
|
|
|
use b8;
|
|
use b8\Form;
|
|
use b8\HttpClient;
|
|
use PHPCI\Controller;
|
|
use PHPCI\Model\Build;
|
|
use Symfony\Component\Yaml\Dumper;
|
|
use Symfony\Component\Yaml\Parser;
|
|
|
|
/**
|
|
* Settings Controller
|
|
*
|
|
* @author Dan Cryer <dan@block8.co.uk>
|
|
* @package PHPCI
|
|
* @subpackage Web
|
|
*/
|
|
class SettingsController extends Controller
|
|
{
|
|
|
|
/**
|
|
* @var array
|
|
*/
|
|
protected $settings;
|
|
|
|
/**
|
|
* Initialise the controller, set up stores and services.
|
|
*/
|
|
public function init()
|
|
{
|
|
parent::init();
|
|
|
|
$parser = new Parser();
|
|
$yaml = file_get_contents(APPLICATION_PATH . 'PHPCI/config.yml');
|
|
$this->settings = $parser->parse($yaml);
|
|
}
|
|
|
|
/**
|
|
* Display settings forms.
|
|
* @return string
|
|
*/
|
|
public function index()
|
|
{
|
|
$this->view->settings = $this->settings;
|
|
|
|
$emailSettings = array();
|
|
if (isset($this->settings['phpci']['email_settings'])) {
|
|
$emailSettings = $this->settings['phpci']['email_settings'];
|
|
}
|
|
|
|
$buildSettings = array();
|
|
if (isset($this->settings['phpci']['build'])) {
|
|
$buildSettings = $this->settings['phpci']['build'];
|
|
}
|
|
|
|
$authenticationSettings = array();
|
|
if (isset($this->settings['phpci']['authentication_settings'])) {
|
|
$authenticationSettings = $this->settings['phpci']['authentication_settings'];
|
|
}
|
|
|
|
$this->view->github = $this->getGithubForm();
|
|
$this->view->emailSettings = $this->getEmailForm($emailSettings);
|
|
$this->view->buildSettings = $this->getBuildForm($buildSettings);
|
|
$this->view->isWriteable = $this->canWriteConfig();
|
|
$this->view->authenticationSettings = $this->getAuthenticationForm($authenticationSettings);
|
|
|
|
if (!empty($this->settings['phpci']['github']['token'])) {
|
|
$this->view->githubUser = $this->getGithubUser($this->settings['phpci']['github']['token']);
|
|
}
|
|
|
|
return $this->view->render();
|
|
}
|
|
|
|
/**
|
|
* Save Github settings.
|
|
*/
|
|
public function github()
|
|
{
|
|
$this->requireAdmin();
|
|
|
|
$this->settings['phpci']['github']['id'] = $this->getParam('githubid', '');
|
|
$this->settings['phpci']['github']['secret'] = $this->getParam('githubsecret', '');
|
|
$error = $this->storeSettings();
|
|
|
|
if ($error) {
|
|
header('Location: ' . PHPCI_URL . 'settings?saved=2');
|
|
} else {
|
|
header('Location: ' . PHPCI_URL . 'settings?saved=1');
|
|
}
|
|
|
|
die;
|
|
}
|
|
|
|
/**
|
|
* Save email settings.
|
|
*/
|
|
public function email()
|
|
{
|
|
$this->requireAdmin();
|
|
|
|
$this->settings['phpci']['email_settings'] = $this->getParams();
|
|
$this->settings['phpci']['email_settings']['smtp_encryption'] = $this->getParam('smtp_encryption', 0);
|
|
|
|
$error = $this->storeSettings();
|
|
|
|
if ($error) {
|
|
header('Location: ' . PHPCI_URL . 'settings?saved=2');
|
|
} else {
|
|
header('Location: ' . PHPCI_URL . 'settings?saved=1');
|
|
}
|
|
|
|
die;
|
|
}
|
|
|
|
/**
|
|
* Save build settings.
|
|
*/
|
|
public function build()
|
|
{
|
|
$this->requireAdmin();
|
|
|
|
$this->settings['phpci']['build'] = $this->getParams();
|
|
|
|
$error = $this->storeSettings();
|
|
|
|
if ($error) {
|
|
header('Location: ' . PHPCI_URL . 'settings?saved=2');
|
|
} else {
|
|
header('Location: ' . PHPCI_URL . 'settings?saved=1');
|
|
}
|
|
|
|
die;
|
|
}
|
|
|
|
/**
|
|
* Handle authentication settings
|
|
*/
|
|
public function authentication()
|
|
{
|
|
$this->requireAdmin();
|
|
|
|
$this->settings['phpci']['authentication_settings']['state'] = $this->getParam('disable_authentication', 0);
|
|
$this->settings['phpci']['authentication_settings']['user_id'] = $_SESSION['phpci_user_id'];
|
|
|
|
$error = $this->storeSettings();
|
|
|
|
if ($error) {
|
|
header('Location: ' . PHPCI_URL . 'settings?saved=2');
|
|
} else {
|
|
header('Location: ' . PHPCI_URL . 'settings?saved=1');
|
|
}
|
|
|
|
die;
|
|
}
|
|
|
|
/**
|
|
* Github redirects users back to this URL when t
|
|
*/
|
|
public function githubCallback()
|
|
{
|
|
$code = $this->getParam('code', null);
|
|
$github = $this->settings['phpci']['github'];
|
|
|
|
if (!is_null($code)) {
|
|
$http = new HttpClient();
|
|
$url = 'https://github.com/login/oauth/access_token';
|
|
$params = array('client_id' => $github['id'], 'client_secret' => $github['secret'], 'code' => $code);
|
|
$resp = $http->post($url, $params);
|
|
|
|
if ($resp['success']) {
|
|
parse_str($resp['body'], $resp);
|
|
|
|
$this->settings['phpci']['github']['token'] = $resp['access_token'];
|
|
$this->storeSettings();
|
|
|
|
header('Location: ' . PHPCI_URL . 'settings?linked=1');
|
|
die;
|
|
}
|
|
}
|
|
|
|
|
|
header('Location: ' . PHPCI_URL . 'settings?linked=2');
|
|
die;
|
|
}
|
|
|
|
/**
|
|
* Convert config to yaml and store to file.
|
|
*
|
|
* @return mixed
|
|
*/
|
|
protected function storeSettings()
|
|
{
|
|
$dumper = new Dumper();
|
|
$yaml = $dumper->dump($this->settings, 4);
|
|
file_put_contents(APPLICATION_PATH . 'PHPCI/config.yml', $yaml);
|
|
|
|
if (error_get_last()) {
|
|
$error_get_last = error_get_last();
|
|
return $error_get_last['message'];
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Get the Github settings form.
|
|
* @return Form
|
|
*/
|
|
protected function getGithubForm()
|
|
{
|
|
$form = new Form();
|
|
$form->setMethod('POST');
|
|
$form->setAction(PHPCI_URL . 'settings/github');
|
|
$form->addField(new Form\Element\Csrf('csrf'));
|
|
|
|
$field = new Form\Element\Text('githubid');
|
|
$field->setRequired(true);
|
|
$field->setPattern('[a-zA-Z0-9]+');
|
|
$field->setLabel('Application ID');
|
|
$field->setClass('form-control');
|
|
$field->setContainerClass('form-group');
|
|
$form->addField($field);
|
|
|
|
if (isset($this->settings['phpci']['github']['id'])) {
|
|
$field->setValue($this->settings['phpci']['github']['id']);
|
|
}
|
|
|
|
$field = new Form\Element\Text('githubsecret');
|
|
$field->setRequired(true);
|
|
$field->setPattern('[a-zA-Z0-9]+');
|
|
$field->setLabel('Application Secret');
|
|
$field->setClass('form-control');
|
|
$field->setContainerClass('form-group');
|
|
$form->addField($field);
|
|
|
|
if (isset($this->settings['phpci']['github']['secret'])) {
|
|
$field->setValue($this->settings['phpci']['github']['secret']);
|
|
}
|
|
|
|
$field = new Form\Element\Submit();
|
|
$field->setValue('Save »');
|
|
$field->setClass('btn btn-success pull-right');
|
|
$form->addField($field);
|
|
|
|
return $form;
|
|
}
|
|
|
|
/**
|
|
* Get the email settings form.
|
|
* @param array $values
|
|
* @return Form
|
|
*/
|
|
protected function getEmailForm($values = array())
|
|
{
|
|
$form = new Form();
|
|
$form->setMethod('POST');
|
|
$form->setAction(PHPCI_URL . 'settings/email');
|
|
$form->addField(new Form\Element\Csrf('csrf'));
|
|
|
|
$field = new Form\Element\Text('smtp_address');
|
|
$field->setRequired(false);
|
|
$field->setLabel('SMTP Server');
|
|
$field->setClass('form-control');
|
|
$field->setContainerClass('form-group');
|
|
$field->setValue('localhost');
|
|
$form->addField($field);
|
|
|
|
$field = new Form\Element\Text('smtp_port');
|
|
$field->setRequired(false);
|
|
$field->setPattern('[0-9]+');
|
|
$field->setLabel('SMTP Port');
|
|
$field->setClass('form-control');
|
|
$field->setContainerClass('form-group');
|
|
$field->setValue(25);
|
|
$form->addField($field);
|
|
|
|
$field = new Form\Element\Text('smtp_username');
|
|
$field->setRequired(false);
|
|
$field->setLabel('SMTP Username');
|
|
$field->setClass('form-control');
|
|
$field->setContainerClass('form-group');
|
|
$form->addField($field);
|
|
|
|
$field = new Form\Element\Text('smtp_password');
|
|
$field->setRequired(false);
|
|
$field->setLabel('SMTP Password');
|
|
$field->setClass('form-control');
|
|
$field->setContainerClass('form-group');
|
|
$form->addField($field);
|
|
|
|
$field = new Form\Element\Email('from_address');
|
|
$field->setRequired(false);
|
|
$field->setLabel('From Email Address');
|
|
$field->setClass('form-control');
|
|
$field->setContainerClass('form-group');
|
|
$form->addField($field);
|
|
|
|
$field = new Form\Element\Email('default_mailto_address');
|
|
$field->setRequired(false);
|
|
$field->setLabel('Default Notification Address');
|
|
$field->setClass('form-control');
|
|
$field->setContainerClass('form-group');
|
|
$form->addField($field);
|
|
|
|
$field = new Form\Element\Select('smtp_encryption');
|
|
$field->setOptions(['' => 'None', 'tls' => 'TLS', 'ssl' => 'SSL']);
|
|
$field->setRequired(false);
|
|
$field->setLabel('Use SMTP encryption?');
|
|
$field->setContainerClass('form-group');
|
|
$field->setValue(1);
|
|
$form->addField($field);
|
|
|
|
$field = new Form\Element\Submit();
|
|
$field->setValue('Save »');
|
|
$field->setClass('btn btn-success pull-right');
|
|
$form->addField($field);
|
|
|
|
$form->setValues($values);
|
|
|
|
return $form;
|
|
}
|
|
|
|
/**
|
|
* Call Github API for our Github user object.
|
|
* @param $token
|
|
* @return mixed
|
|
*/
|
|
protected function getGithubUser($token)
|
|
{
|
|
$http = new HttpClient('https://api.github.com');
|
|
$user = $http->get('/user', array('access_token' => $token));
|
|
|
|
return $user['body'];
|
|
}
|
|
|
|
/**
|
|
* Check if we can write the PHPCI config file.
|
|
* @return bool
|
|
*/
|
|
protected function canWriteConfig()
|
|
{
|
|
return is_writeable(APPLICATION_PATH . 'PHPCI/config.yml');
|
|
}
|
|
|
|
/**
|
|
* Get the Build settings form.
|
|
* @param array $values
|
|
* @return Form
|
|
*/
|
|
protected function getBuildForm($values = array())
|
|
{
|
|
$form = new Form();
|
|
$form->setMethod('POST');
|
|
$form->setAction(PHPCI_URL . 'settings/build');
|
|
|
|
$field = new Form\Element\Select('failed_after');
|
|
$field->setRequired(false);
|
|
$field->setLabel('Consider a build failed after');
|
|
$field->setClass('form-control');
|
|
$field->setContainerClass('form-group');
|
|
$field->setOptions([
|
|
300 => '5 Minutes',
|
|
900 => '15 Minutes',
|
|
1800 => '30 Minutes',
|
|
3600 => '1 Hour',
|
|
10800 => '3 Hours',
|
|
]);
|
|
$field->setValue(1800);
|
|
$form->addField($field);
|
|
|
|
|
|
$field = new Form\Element\Submit();
|
|
$field->setValue('Save »');
|
|
$field->setClass('btn btn-success pull-right');
|
|
$form->addField($field);
|
|
|
|
$form->setValues($values);
|
|
|
|
return $form;
|
|
}
|
|
|
|
/**
|
|
* Form for disabling user authentication while using a default user
|
|
*
|
|
* @param array $values
|
|
* @return Form
|
|
*/
|
|
protected function getAuthenticationForm($values = array())
|
|
{
|
|
$form = new Form();
|
|
$form->setMethod('POST');
|
|
$form->setAction(PHPCI_URL . 'settings/authentication');
|
|
$form->addField(new Form\Element\Csrf('csrf'));
|
|
|
|
$field = new Form\Element\Checkbox('disable_authentication');
|
|
$field->setCheckedValue(1);
|
|
$field->setRequired(false);
|
|
$field->setLabel('Disable Authentication?');
|
|
$field->setContainerClass('form-group');
|
|
$field->setValue(0);
|
|
|
|
if (isset($values['state'])) {
|
|
$field->setValue((int)$values['state']);
|
|
}
|
|
|
|
$form->addField($field);
|
|
|
|
$field = new Form\Element\Submit();
|
|
$field->setValue('Save »');
|
|
$field->setClass('btn btn-success pull-right');
|
|
$form->addField($field);
|
|
|
|
$form->setValues($values);
|
|
|
|
return $form;
|
|
}
|
|
}
|