|
Perforce Chronicle 2012.2/486814
API Documentation
|
This is the Perforce server setup form. More...
Public Member Functions | |
| init () | |
| Defines the elements that make up the Perforce server form. | |
| isP4dInstalled () | |
| Check if the Perforce Server daemon is available. | |
| isP4dValid () | |
| Check if the Perforce Server daemon is the correct version. | |
| isP4ServerVersionValid ($serverVersion) | |
| Check the P4 server version. | |
| isValid ($data) | |
| Override isValid to check connection parameters. | |
Public Attributes | |
| const | SERVER_TYPE_EXISTING = 'existing' |
| const | SERVER_TYPE_NEW = 'new' |
This is the Perforce server setup form.
| Setup_Form_Storage::init | ( | ) |
Defines the elements that make up the Perforce server form.
Called automatically when the form object is created.
{
// form should use p4cms-ui styles.
$this->setAttrib('class', 'p4cms-ui storage-form');
// form should submit on enter
$this->setAttrib('submitOnEnter', true);
// set the method for the display form to POST
$this->setMethod('post');
// add option
$this->addElement(
'radio',
'serverType',
array(
'multiOptions' => array(
static::SERVER_TYPE_NEW
=> 'In a new Perforce Server on the same machine as Chronicle',
static::SERVER_TYPE_EXISTING
=> 'In a new depot on an existing Perforce Server'
),
'value' => static::SERVER_TYPE_NEW,
'required' => true,
'onClick' => "if (this.value == '" . static::SERVER_TYPE_NEW . "') {\n"
. " p4cms.ui.hide('fieldset-existingServer');\n"
. "} else {\n"
. " p4cms.ui.show('fieldset-existingServer');\n"
. " dojo.query('#port-element input')[0].focus();\n"
. "}"
)
);
// if a valid p4d is installed, default serverType to 'new'.
// otherwise, disable the 'new' option.
$serverType = $this->getElement('serverType');
if ($this->isP4dInstalled() && $this->isP4dValid()) {
$serverType->setValue(static::SERVER_TYPE_NEW);
} else {
$serverType->setValue(static::SERVER_TYPE_EXISTING)
->setAttrib('disable', array(static::SERVER_TYPE_NEW));
}
// add a field to collect the perforce server port.
$this->addElement(
'text',
'port',
array(
'label' => 'Server Address',
'value' => 'perforce:1666',
'required' => true,
'description' => "Enter the host name and port of your Perforce Server (e.g. localhost:1666)",
'validators' => array(array('Port'))
)
);
// put the port, user and password in a display group.
$this->addDisplayGroup(
array('port'),
'existingServer',
array('class' => 'existing-server')
);
// add the submit button
$this->addElement(
'SubmitButton',
'continue',
array(
'label' => 'Continue',
'class' => 'button-large preferred',
'ignore' => true
)
);
$this->addElement(
'SubmitButton',
'goback',
array(
'label' => 'Go Back',
'class' => 'button-large',
'ignore' => true
)
);
// put the button in a fieldset.
$this->addDisplayGroup(
array('continue', 'goback'),
'buttons',
array('class' => 'buttons')
);
}
| Setup_Form_Storage::isP4dInstalled | ( | ) |
Check if the Perforce Server daemon is available.
{
exec(Setup_IndexController::P4D_BINARY .' -V 2>&1', $output, $return);
if ($return === 0) {
return true;
}
}
| Setup_Form_Storage::isP4dValid | ( | ) |
Check if the Perforce Server daemon is the correct version.
{
exec(Setup_IndexController::P4D_BINARY .' -V 2>&1', $output, $return);
if (preg_match(":P4D/[^/]*/([^/]+)/:i", implode("\n", $output), $matches)) {
return $this->isP4ServerVersionValid($matches[0]);
}
return false;
}
| Setup_Form_Storage::isP4ServerVersionValid | ( | $ | serverVersion | ) |
Check the P4 server version.
| string | $serverVersion | P4 server version string |
{
$minVersion = strtolower(Setup_IndexController::MIN_P4_VERSION);
$versionBits = explode("/", $serverVersion);
$p4dVersion = 0;
if (array_key_exists('2', $versionBits)) {
$p4dVersion = $versionBits[2];
}
return (version_compare(strtolower($p4dVersion), $minVersion) < 0) ? false : true;
}
| Setup_Form_Storage::isValid | ( | $ | data | ) |
Override isValid to check connection parameters.
| array | $data | the field values to validate. |
Reimplemented from P4Cms_Form.
{
// if serverType is 'new', ensure p4d is installed and valid.
if (isset($data['serverType'])
&& $data['serverType'] === static::SERVER_TYPE_NEW
) {
if ($this->isP4dInstalled() && $this->isP4dValid()) {
// nothing more to validate.
return true;
} else {
$this->getElement('serverType')->addError(
"Cannot create a local depot. A valid Perforce Server is not installed."
);
return false;
}
}
// do basic validation.
if (!parent::isValid($data)) {
return false;
}
// Since we presumably have a valid port, now we need to 'connect' and determine
// whether the target server is sufficiently new to host the application.
$info = array();
try {
// note: auto user creation does not appear to be triggered for the info command
// but should that change, we create a highly-unlikely username for the connection test.
$username = md5(mt_rand());
$p4 = P4_Connection::factory($this->getValue('port'), $username);
$info = $p4->getInfo();
} catch (P4_Connection_ConnectException $e) {
// prime error with a generic message
$error = "Unable to connect to server on '" . $this->getValue('port') . "'.";
// if the issue is related to the ssl library version, provide a detailed error
if (preg_match('/SSL library must be at least version [0-9\.]+/', $e->getMessage(), $matches)) {
$error = 'Unable to connect. ' . $matches[0];
}
$this->getElement('port')->addError($error);
return false;
}
// check server version.
if (!$this->isP4ServerVersionValid($info['serverVersion'])) {
$this->getElement('port')->addError(
"This server version is not supported. It is version "
. $info['serverVersion']
. ". Version "
. Setup_IndexController::MIN_P4_VERSION
. " or greater is required."
);
return false;
}
// verify the 'chronicle' user is available if this is the initial setup.
// if the application has no perforce resource, we assume initial setup.
try {
$bootstrap = Zend_Controller_Front::getInstance()->getParam("bootstrap");
$perforce = $bootstrap ? $bootstrap->getResource('perforce') : null;
if (!$perforce && P4_User::exists(Setup_IndexController::P4D_USER, $p4)) {
$this->getElement('port')->addError(
"The 'chronicle' user is already in use on this server."
);
return false;
}
} catch (P4_Exception $e) {
// this check will fail if auto-user creation is disabled,
// but we check it again during admin form validation.
}
// passed all checks.
return true;
}
| const Setup_Form_Storage::SERVER_TYPE_EXISTING = 'existing' |
| const Setup_Form_Storage::SERVER_TYPE_NEW = 'new' |