mirror of
https://we.phorge.it/source/phorge.git
synced 2024-11-16 03:42:41 +01:00
736857d1f6
Summary: Fixes T6533 - actively prompt the user to install and enable pygments Test Plan: uninstalled / disabled pygments and checked setup checks Reviewers: #blessed_reviewers, epriestley Reviewed By: #blessed_reviewers, epriestley Subscribers: Korvin, epriestley Maniphest Tasks: T6533 Differential Revision: https://secure.phabricator.com/D11048
69 lines
2.6 KiB
PHP
69 lines
2.6 KiB
PHP
<?php
|
|
|
|
final class PhabricatorSetupCheckPygment extends PhabricatorSetupCheck {
|
|
|
|
protected function executeChecks() {
|
|
$pygment = PhabricatorEnv::getEnvConfig('pygments.enabled');
|
|
|
|
if ($pygment) {
|
|
if (!Filesystem::binaryExists('pygmentize')) {
|
|
$summary = pht(
|
|
'You enabled pygments but the pygmentize script is not '.
|
|
'actually available, your $PATH is probably broken.');
|
|
|
|
$message = pht(
|
|
'The environmental variable $PATH does not contain '.
|
|
'pygmentize. You have enabled pygments, which requires '.
|
|
'pygmentize to be available in your $PATH variable.');
|
|
|
|
$this
|
|
->newIssue('pygments.enabled')
|
|
->setName(pht('pygmentize Not Found'))
|
|
->setSummary($summary)
|
|
->setMessage($message)
|
|
->addRelatedPhabricatorConfig('pygments.enabled')
|
|
->addPhabricatorConfig('environment.append-paths');
|
|
} else {
|
|
list($err) = exec_manual('pygmentize -h');
|
|
if ($err) {
|
|
$summary = pht(
|
|
'You have enabled pygments and the pygmentize script is '.
|
|
'available, but does not seem to work.');
|
|
|
|
$message = pht(
|
|
'Phabricator has %s available in $PATH, but the binary '.
|
|
'exited with an error code when run as %s. Check that it is '.
|
|
'installed correctly.',
|
|
phutil_tag('tt', array(), 'pygmentize'),
|
|
phutil_tag('tt', array(), 'pygmentize -h'));
|
|
|
|
$this
|
|
->newIssue('pygments.failed')
|
|
->setName(pht('pygmentize Not Working'))
|
|
->setSummary($summary)
|
|
->setMessage($message)
|
|
->addRelatedPhabricatorConfig('pygments.enabled')
|
|
->addPhabricatorConfig('environment.append-paths');
|
|
}
|
|
}
|
|
} else {
|
|
$summary = pht('Pygments should be installed and enabled '.
|
|
'to provide advanced syntax highlighting.');
|
|
|
|
$message = pht('Phabricator can highlight a few languages by default, '.
|
|
'but installing and enabling Pygments (a third-party highlighting '.
|
|
'tool) will add syntax highlighting for many more languages. '."\n\n".
|
|
'For instructions on installing and enabling Pygments, see the '.
|
|
'%s configuration option.'."\n\n".
|
|
'If you do not want to install Pygments, you can ignore this issue.',
|
|
phutil_tag('tt', array(), 'pygments.enabled'));
|
|
|
|
$this
|
|
->newIssue('pygments.noenabled')
|
|
->setName(pht('Install Pygments to Improve Syntax Highlighting'))
|
|
->setSummary($summary)
|
|
->setMessage($message)
|
|
->addRelatedPhabricatorConfig('pygments.enabled');
|
|
}
|
|
}
|
|
}
|