public function initialize()
{
$filename = THEBUGGENIE_PATH . 'i18n' . DS . $this->_language . DS . 'initialize.inc.php';
if (file_exists($filename)) {
Logging::log("Initiating with file '{$filename}", 'i18n');
include $filename;
Logging::log("Done Initiating", 'i18n');
}
if ($this->_strings === null) {
if (Context::getCache()->fileHas(Cache::KEY_I18N . 'strings_' . $this->_language, false)) {
Logging::log('Trying cached strings');
$strings = Context::getCache()->fileGet(Cache::KEY_I18N . 'strings_' . $this->_language, false);
$this->_strings = is_array($strings) ? $strings : null;
}
if ($this->_strings === null) {
Logging::log('No usable cached strings available');
$this->loadStrings();
foreach (array_keys(Context::getModules()) as $module_name) {
$this->loadStrings($module_name);
}
if (is_array($this->_strings)) {
Context::getCache()->fileAdd(Cache::KEY_I18N . 'strings_' . $this->_language, $this->_strings, false);
}
}
}
}
/**
* Returns an array of regular expressions that should be used for matching
* the issue numbers and workflow transitions in a VCS commit.
*
* Each element of an array is a single regular expression that will be
* applied against the incoming commit message. Each regular expression
* should have two named patterns - one denoting the issue number (should
* include prefix if used in project), and one denoting workflow
* transitions.
*
* Simple example would be:
*
* '#fixes issue #(?P<issues>([A-Z0-9]+\-)?\d+) (?P<transitions> \(.*?\))?#i'
*
* @return array
*/
public static function getIssueRegex()
{
// Try getting the regexes from cache first.
if (!($regex = framework\Context::getCache()->get(framework\Cache::KEY_TEXTPARSER_ISSUE_REGEX))) {
// List of keywords that are expected to prefix the issue number in a
// commit message (these are _not_ project prefixes).
$issue_strings = array('bug', 'issue', 'ticket', 'fix', 'fixes', 'fixed', 'fixing', 'applies to', 'closes', 'references', 'ref', 'addresses', 're', 'see', 'according to', 'also see', 'story');
// Add the issue types as prefixes as well.
foreach (\thebuggenie\core\entities\Issuetype::getAll() as $issuetype) {
$issue_strings[] = $issuetype->getName();
}
// Construct the OR'ed (|) regex out of issue prefixes.
$issue_string = join('|', $issue_strings);
$issue_string = html_entity_decode($issue_string, ENT_QUOTES);
$issue_string = str_replace(array(' ', "'"), array('\\s{1,1}', "\\'"), $issue_string);
// Store all regular expressions for mathces in an array.
$regex = array();
// This regex will match messages that contain template like "KEYWORD
// (#)ISSUE_NUMBER (TRANSITIONS)" (parenthesis means optional). For
// example:
// "Resolves issue #2 (Resolve issue)"
$regex[] = '#( |^)(?<!\\!)((' . $issue_string . ')\\s\\#?(?P<issues>([A-Z0-9]+\\-)?\\d+))( \\((?P<transitions>.*?)\\))?#i';
// This regex will match messages that contain template at the beginning
// of message in format "ISSUE_NUMBER: (TRANSITIONS)".
$regex[] = '#^(?<!\\!)((?P<issues>([A-Z0-9]+\\-)?\\d+)):( \\((?P<transitions>.*?)\\))?#i';
// Add the constructed regexes to cache.
framework\Context::getCache()->add(framework\Cache::KEY_TEXTPARSER_ISSUE_REGEX, $regex);
}
// Return the regular expressions.
return $regex;
}
public function do_execute()
{
if (file_exists(THEBUGGENIE_PATH . 'installed')) {
$this->cliEcho("The Bug Genie seems to already be installed.\n", 'red', 'bold');
$this->cliEcho('Please remove the file ');
$this->cliEcho(THEBUGGENIE_PATH . 'installed', 'white', 'bold');
$this->cliEcho(' and try again.');
$this->cliEcho("\n");
return;
}
$this->cliEcho("\nWelcome to the \"The Bug Genie\" installation wizard!\n", 'white', 'bold');
$this->cliEcho("This wizard will take you through the installation of The Bug Genie.\nRemember that you can also install The Bug Genie from your web-browser.\n");
$this->cliEcho("Simply point your web-browser to the The Bug Genie subdirectory on your web server,\nand the installation will start.\n\n");
$this->cliEcho("Press ENTER to continue with the installation: ");
$this->pressEnterToContinue();
$this->cliEcho("\n");
$this->cliEcho("How to support future development\n", 'green', 'bold');
$this->cliEcho("Even though this software has been provided to you free of charge,\ndeveloping it would not have been possible without support from our users.\n");
$this->cliEcho("By making a donation, or buying a support contract you can help us continue development.\n\n");
$this->cliEcho("If this software is valuable to you - please consider supporting it.\n\n");
$this->cliEcho("More information about supporting The Bug Genie's development can be found here:\n");
$this->cliEcho("http://www.thebuggenie.com/support\n\n", 'blue', 'underline');
$this->cliEcho("Press ENTER to continue: ");
$this->pressEnterToContinue();
$this->cliEcho("\n");
try {
$this->cliEcho("License information\n", 'green', 'bold');
$this->cliEcho("This software is Open Source Initiative approved Open Source Software.\nOpen Source Initiative Approved is a trademark of the Open Source Initiative.\n\n");
$this->cliEcho("True to the the Open Source Definition, The Bug Genie is released\nunder the MPL 2.0. You can read the full license here:\n");
$this->cliEcho("http://opensource.org/licenses/MPL-2.0\n\n", 'blue', 'underline');
if ($this->getProvidedArgument('accept_license') != 'yes') {
$this->cliEcho("Before you can continue the installation, you need to confirm that you \nagree to be bound by the terms in this license.\n\n");
$this->cliEcho("Do you agree to be bound by the terms in the MPL 2.0 license?\n(type \"yes\" to agree, anything else aborts the installation): ");
if (!$this->askToAccept()) {
throw new \Exception($this->cliEcho('You need to accept the license to continue', 'red', 'bold'));
}
} else {
$this->cliEcho('You have accepted the license', 'yellow', 'bold');
$this->cliEcho("\n\n");
}
$not_well = array();
if (!is_writable(\THEBUGGENIE_CONFIGURATION_PATH)) {
$not_well[] = 'b2db_perm';
}
if (!is_writable(THEBUGGENIE_PATH)) {
$not_well[] = 'root';
}
if (count($not_well) > 0) {
$this->cliEcho("\n");
foreach ($not_well as $afail) {
switch ($afail) {
case 'b2db_perm':
$this->cliEcho("Could not write to the B2DB directory\n", 'red', 'bold');
$this->cliEcho('The folder ');
$this->cliEcho(\THEBUGGENIE_CONFIGURATION_PATH, 'white', 'bold');
$this->cliEcho(' folder needs to be writable');
break;
case 'root':
$this->cliEcho("Could not write to the main directory\n", 'red', 'bold');
$this->cliEcho('The top level folder must be writable during installation');
break;
}
}
throw new \Exception("\n\nYou need to correct the above errors before the installation can continue.");
} else {
$this->cliEcho("Step 1 - database information\n");
if (file_exists($this->_b2db_config_file)) {
$this->cliEcho("You seem to already have completed this step successfully.\n");
if ($this->getProvidedArgument('use_existing_db_info') == 'yes') {
$this->cliEcho("\n");
$this->cliEcho("Using existing database information\n", 'yellow', 'bold');
$use_existing_db_info = true;
} else {
$this->cliEcho("Do you want to use the stored settings?\n", 'white', 'bold');
$this->cliEcho("\nType \"no\" to enter new settings, press ENTER to use existing: ", 'white', 'bold');
$use_existing_db_info = $this->askToDecline();
}
$this->cliEcho("\n");
} else {
$use_existing_db_info = false;
}
if (!$use_existing_db_info) {
$this->cliEcho("The Bug Genie uses a database to store information. To be able to connect\nto your database, The Bug Genie needs some information, such as\ndatabase type, username, password, etc.\n\n");
$this->cliEcho("Please select what kind of database you are installing The Bug Genie on:\n");
$db_types = array();
foreach (\b2db\Core::getDBtypes() as $db_type => $db_desc) {
$db_types[] = $db_type;
$this->cliEcho(count($db_types) . ': ' . $db_desc . "\n", 'white', 'bold');
}
do {
$this->cliEcho('Enter the corresponding number for the database (1-' . count($db_types) . '): ');
$db_selection = $this->getInput();
if (!isset($db_types[(int) $db_selection - 1])) {
throw new \Exception($db_selection . ' is not a valid database type selection');
}
$db_type = $db_types[(int) $db_selection - 1];
$this->cliEcho("Selected database type: ");
$this->cliEcho($db_type . "\n\n");
$this->cliEcho("Please enter the database hostname: \n");
$this->cliEcho('Database hostname [localhost]: ', 'white', 'bold');
$db_hostname = $this->getInput();
$db_hostname = $db_hostname == '' ? 'localhost' : $db_hostname;
$this->cliEcho("\nPlease enter the username The Bug Genie will use to connect to the database: \n");
$this->cliEcho('Database username: '******'white', 'bold');
$db_username = $this->getInput();
$this->cliEcho("Database password (press ENTER if blank): ", 'white', 'bold');
$db_password = $this->getInput();
$this->cliEcho("\nPlease enter the database The Bug Genie will use.\nIf it does not exist, The Bug Genie will create it for you.\n(the default database name is ");
$this->cliEcho("thebuggenie_db", 'white', 'bold');
$this->cliEcho(" - press ENTER to use that):\n");
$this->cliEcho('Database name: ', 'white', 'bold');
$db_name = $this->getInput('thebuggenie_db');
$this->cliEcho("\n");
$this->cliEcho("The following settings will be used:\n");
$this->cliEcho("Database type: \t\t", 'white', 'bold');
$this->cliEcho($db_type . "\n");
$this->cliEcho("Database hostname: \t", 'white', 'bold');
$this->cliEcho($db_hostname . "\n");
$this->cliEcho("Database username: \t", 'white', 'bold');
$this->cliEcho($db_username . "\n");
$this->cliEcho("Database password: \t", 'white', 'bold');
$this->cliEcho($db_password . "\n");
$this->cliEcho("Database name: \t\t", 'white', 'bold');
$this->cliEcho($db_name . "\n");
$this->cliEcho("\nIf these settings are ok, press ENTER, or anything else to retry: ");
$e_ok = $this->askToDecline();
} while (!$e_ok);
try {
\b2db\Core::setHost($db_hostname);
\b2db\Core::setUname($db_username);
\b2db\Core::setPasswd($db_password);
\b2db\Core::setDBtype($db_type);
\b2db\Core::setTablePrefix('tbg_');
\b2db\Core::doConnect();
\b2db\Core::createDatabase($db_name);
\b2db\Core::setDBname($db_name);
\b2db\Core::doConnect();
} catch (\Exception $e) {
throw new \Exception("Could not connect to the database:\n" . $e->getMessage());
}
\b2db\Core::setDBname($db_name);
$this->cliEcho("\nSuccessfully connected to the database.\n", 'green');
$this->cliEcho("Press ENTER to continue ... ");
$this->pressEnterToContinue();
$this->cliEcho("\n");
$this->cliEcho("Saving database connection information ... ", 'white', 'bold');
$this->cliEcho("\n");
\b2db\Core::saveConnectionParameters($this->_b2db_config_file);
$this->cliEcho("Successfully saved database connection information.\n", 'green');
$this->cliEcho("\n");
} else {
$b2db_config = \Spyc::YAMLLoad($this->_b2db_config_file);
if (!array_key_exists("b2db", $b2db_config)) {
throw new \Exception("Could not find database configuration in file " . $this->_b2db_config_file);
}
try {
\b2db\Core::initialize($b2db_config["b2db"], \thebuggenie\core\framework\Context::getCache());
\b2db\Core::doConnect();
} catch (\Exception $e) {
throw new \Exception("Could not connect to the database:\n" . $e->getMessage() . "\nPlease check your configuration file " . $this->_b2db_config_file);
}
$this->cliEcho("Successfully connected to the database.\n", 'green');
}
$this->cliEcho("\nThe Bug Genie needs some server settings to function properly...\n\n");
do {
$this->cliEcho("URL rewriting\n", 'cyan', 'bold');
$this->cliEcho("The Bug Genie uses a technique called \"url rewriting\" - which allows for pretty\nURLs such as ") . $this->cliEcho('/issue/1', 'white', 'bold') . $this->cliEcho(' instead of ') . $this->cliEcho("viewissue.php?issue_id=1\n", 'white', 'bold');
$this->cliEcho("Make sure you have read the URL_REWRITE document located in the root\nfolder, or at http://www.thebuggenie.com before you continue\n");
if (!$this->hasProvidedArgument('url_subdir')) {
$this->cliEcho("Press ENTER to continue ... ");
$this->pressEnterToContinue();
}
$this->cliEcho("\n");
$this->cliEcho("The Bug Genie subdir\n", 'white', 'bold');
$this->cliEcho("This is the sub-path of the Web server where The Bug Genie will be located.\n");
if ($this->hasProvidedArgument('url_subdir')) {
$this->cliEcho('The Bug Genie subdir: ', 'white', 'bold');
$url_subdir = $this->getProvidedArgument('url_subdir');
$this->cliEcho($url_subdir, 'yellow', 'bold');
$this->cliEcho("\n");
} else {
$this->cliEcho('Start and end this with a forward slash', 'white', 'bold');
$this->cliEcho(". (ex: \"/thebuggenie/\")\nIf The Bug Genie is running at the root directory, just type \"/\" (without the quotes)\n\n");
$this->cliEcho('The Bug Genie subdir: ', 'white', 'bold');
$url_subdir = $this->getInput();
}
$this->cliEcho("\n");
$this->cliEcho("The Bug Genie will now be accessible at\n");
$this->cliEcho("http://example.com" . $url_subdir, 'white', 'bold');
if ($this->hasProvidedArgument('url_subdir')) {
$this->cliEcho("\n");
$this->cliEcho("Using existing values", 'yellow', 'bold');
$this->cliEcho("\n");
$e_ok = true;
} else {
$this->cliEcho("\nPress ENTER if ok, or \"no\" to try again: ");
$e_ok = $this->askToDecline();
}
$this->cliEcho("\n");
} while (!$e_ok);
if ($this->getProvidedArgument('setup_htaccess') != 'yes') {
$this->cliEcho("Setup can autoconfigure your .htaccess and .user.ini files (located in the thebuggenie/ subfolder), so you don't have to.\n");
$this->cliEcho('Would you like setup to auto-generate those files for you?');
$this->cliEcho("\nPress ENTER if ok, or \"no\" to not set up the .htaccess and .user.ini files: ");
$htaccess_ok = $this->askToDecline();
} else {
$this->cliEcho('Autoconfiguring .htaccess and .user.ini', 'yellow', 'bold');
$this->cliEcho("\n");
$htaccess_ok = true;
}
$this->cliEcho("\n");
if ($htaccess_ok) {
if (!is_writable(THEBUGGENIE_PATH . 'thebuggenie/') || file_exists(THEBUGGENIE_PATH . 'thebuggenie/.htaccess') && !is_writable(THEBUGGENIE_PATH . 'thebuggenie/.htaccess')) {
$this->cliEcho("Permission denied when trying to save the [main folder]/thebuggenie/.htaccess\n", 'red', 'bold');
$this->cliEcho("You will have to set up the .htaccess file yourself. See the README file for more information.\n", 'white', 'bold');
$this->cliEcho('Please note: ', 'white', 'bold');
$this->cliEcho("The Bug Genie will not function properly until the .htaccess file is properly set up!\n");
} else {
$content = str_replace('###PUT URL SUBDIRECTORY HERE###', $url_subdir, file_get_contents(THEBUGGENIE_CORE_PATH . 'templates/htaccess.template'));
file_put_contents(THEBUGGENIE_PATH . 'thebuggenie/.htaccess', $content);
if (file_get_contents(THEBUGGENIE_PATH . 'thebuggenie/.htaccess') != $content) {
$this->cliEcho("Permission denied when trying to save the [main folder]/thebuggenie/.htaccess\n", 'red', 'bold');
$this->cliEcho("You will have to set up the .htaccess file yourself. See the README file for more information.\n", 'white', 'bold');
$this->cliEcho('Please note: ', 'white', 'bold');
$this->cliEcho("The Bug Genie will not function properly until the .htaccess file is properly set up!\n");
} else {
$this->cliEcho("The .htaccess file was successfully set up...\n", 'green', 'bold');
}
}
if (!is_writable(THEBUGGENIE_PATH . 'thebuggenie/') || file_exists(THEBUGGENIE_PATH . 'thebuggenie/.user.ini') && !is_writable(THEBUGGENIE_PATH . 'thebuggenie/.user.ini')) {
$this->cliEcho("Permission denied when trying to save the [main folder]/thebuggenie/.user.ini\n", 'red', 'bold');
$this->cliEcho("You will have to set up the .user.ini file yourself. See the README file for more information.\n", 'white', 'bold');
$this->cliEcho('Please note: ', 'white', 'bold');
$this->cliEcho("If you're using PHP-FPM, The Bug Genie might not function properly until the .user.ini file is properly set up\n");
} else {
$content = file_get_contents(THEBUGGENIE_CORE_PATH . 'templates/htaccess.template');
file_put_contents(THEBUGGENIE_PATH . 'thebuggenie/.user.ini', $content);
if (file_get_contents(THEBUGGENIE_PATH . 'thebuggenie/.user.ini') != $content) {
$this->cliEcho("Permission denied when trying to save the [main folder]/thebuggenie/.user.ini\n", 'red', 'bold');
$this->cliEcho("You will have to set up the .user.ini file yourself. See the README file for more information.\n", 'white', 'bold');
$this->cliEcho('Please note: ', 'white', 'bold');
$this->cliEcho("If you're using PHP-FPM, The Bug Genie might not function properly until the .user.ini file is properly set up\n");
} else {
$this->cliEcho("The .user.ini file was successfully set up...\n", 'green', 'bold');
}
}
} else {
$this->cliEcho("Skipping .htaccess and .user.ini auto-setup.");
}
if ($this->getProvidedArgument('setup_htaccess') != 'yes') {
$this->cliEcho("Press ENTER to continue ... ");
$this->pressEnterToContinue();
$this->cliEcho("\n");
}
$this->cliEcho("\n");
$this->cliEcho("Creating tables ...\n", 'white', 'bold');
$b2db_entities_path = THEBUGGENIE_CORE_PATH . 'entities' . DS . 'tables' . DS;
$tables_created = array();
foreach (scandir($b2db_entities_path) as $tablefile) {
if (in_array($tablefile, array('.', '..'))) {
continue;
}
if (($tablename = mb_substr($tablefile, 0, mb_strpos($tablefile, '.'))) != '') {
$tablename = "\\thebuggenie\\core\\entities\\tables\\{$tablename}";
$reflection = new \ReflectionClass($tablename);
$docblock = $reflection->getDocComment();
$annotationset = new \b2db\AnnotationSet($docblock);
if ($annotationset->hasAnnotation('Table')) {
\b2db\Core::getTable($tablename)->create();
\b2db\Core::getTable($tablename)->createIndexes();
$tables_created[] = $tablename;
}
}
}
$this->cliEcho("\n");
$this->cliEcho("All tables successfully created...\n\n", 'green', 'bold');
$this->cliEcho("Setting up initial scope... \n", 'white', 'bold');
\thebuggenie\core\framework\Context::reinitializeI18n('en_US');
$scope = new \thebuggenie\core\entities\Scope();
$scope->setName('The default scope');
$scope->addHostname('*');
$scope->setEnabled();
\thebuggenie\core\framework\Context::setScope($scope);
$scope->save();
\thebuggenie\core\framework\Settings::saveSetting('language', 'en_US');
$this->cliEcho("Initial scope setup successfully... \n\n", 'green', 'bold');
$this->cliEcho("Setting up modules... \n", 'white', 'bold');
try {
foreach (array('publish', 'mailing', 'vcs_integration') as $module) {
$this->cliEcho("Installing {$module}... \n");
\thebuggenie\core\entities\Module::installModule($module);
}
$this->cliEcho("\n");
$this->cliEcho("All modules installed successfully...\n", 'green', 'bold');
$this->cliEcho("\n");
$this->cliEcho("Finishing installation... \n", 'white', 'bold');
$installed_string = \thebuggenie\core\framework\Settings::getMajorVer() . '.' . \thebuggenie\core\framework\Settings::getMinorVer() . ', installed ' . date('d.m.Y H:i');
if (file_exists(THEBUGGENIE_PATH . 'installed') && !is_writable(THEBUGGENIE_PATH . 'installed') || !file_exists(THEBUGGENIE_PATH . 'installed') && !is_writable(THEBUGGENIE_PATH)) {
$this->cliEcho("\n");
$this->cliEcho("Could not create the 'installed' file.\n", 'red', 'bold');
$this->cliEcho("Please create the file ");
$this->cliEcho(THEBUGGENIE_PATH . "installed\n", 'white', 'bold');
$this->cliEcho("with the following line inside:\n");
$this->cliEcho($installed_string, 'blue', 'bold');
$this->cliEcho("\n");
$this->cliEcho("This can be done by running the following command when installation has finished:\n");
$this->cliEcho('echo "' . $installed_string . '" > ' . THEBUGGENIE_PATH . 'installed', 'white', 'bold');
$this->cliEcho("\n");
$this->cliEcho("Press ENTER to continue ... ");
$this->pressEnterToContinue();
$this->cliEcho("\n");
$this->cliEcho("\n");
} else {
file_put_contents(THEBUGGENIE_PATH . 'installed', $installed_string);
}
$this->cliEcho("The installation was completed successfully!\n", 'green', 'bold');
$this->cliEcho("\nTo use The Bug Genie, access http://example.com" . $url_subdir . "index.php with a web-browser.\n");
$this->cliEcho("The default username is ") . $this->cliEcho('Administrator') . $this->cliEcho(' and the password is ') . $this->cliEcho('admin');
$this->cliEcho("\n\nFor support, please visit ") . $this->cliEcho('http://www.thebuggenie.com/', 'blue', 'underline');
$this->cliEcho("\n");
} catch (\Exception $e) {
throw new \Exception("Could not install the {$module} module:\n" . $e->getMessage());
}
}
} catch (\Exception $e) {
$this->cliEcho("\n\nThe installation was interrupted\n", 'red');
$this->cliEcho($e->getMessage() . "\n");
}
$this->cliEcho("\n");
}
public function cache()
{
Context::getCache()->fileAdd(Cache::KEY_ROUTES_CACHE, $this->getRoutes());
Context::getCache()->add(Cache::KEY_ROUTES_CACHE, $this->getRoutes());
Context::getCache()->fileAdd(Cache::KEY_COMPONENT_OVERRIDE_MAP_CACHE, $this->getComponentOverrideMap());
Context::getCache()->add(Cache::KEY_COMPONENT_OVERRIDE_MAP_CACHE, $this->getComponentOverrideMap());
Context::getCache()->fileAdd(Cache::KEY_ANNOTATION_LISTENERS_CACHE, $this->getAnnotationListeners());
Context::getCache()->add(Cache::KEY_ANNOTATION_LISTENERS_CACHE, $this->getAnnotationListeners());
}
public function saveLinkOrder($links)
{
foreach ($links as $key => $link_id) {
$crit = $this->getCriteria();
$crit->addUpdate(self::LINK_ORDER, $key + 1);
$crit->addWhere(self::SCOPE, framework\Context::getScope()->getID());
$this->doUpdateById($crit, $link_id);
}
framework\Context::getCache()->clearCacheKeys(array(framework\Cache::KEY_MAIN_MENU_LINKS));
}
protected function _postSave($is_new)
{
framework\Context::getCache()->delete(framework\Cache::KEY_TEXTPARSER_ISSUE_REGEX);
}
