natalie/indefero
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
bb13722a2f
indefero/src/IDF/Plugin/SyncMonotone.php

250 lines
8.3 KiB
PHP
Raw Normal View History

First attempt on a monotone plugin which creates a new database upon project creation and adds the new server to the running usher instance. If everything goes well, the usher instance is told to reload its configuration, so the new server / database is picked up and started automatically.
2010-08-28 23:10:08 +00:00
<?php
/* -*- tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
# ***** BEGIN LICENSE BLOCK *****
# This file is part of InDefero, an open source project management application.
- initial work on a mtn-post-push script which updates IDF's timeline when new revisions arrive. this still needs some more tests, but its a start. - refactor out the monotonerc template from SyncMonotone.php and place it in a separate template file (access control hooks are still missing from there)
2010-08-30 11:20:47 +00:00
# Copyright (C) 2010 Céondo Ltd and contributors.
First attempt on a monotone plugin which creates a new database upon project creation and adds the new server to the running usher instance. If everything goes well, the usher instance is told to reload its configuration, so the new server / database is picked up and started automatically.
2010-08-28 23:10:08 +00:00
#
# InDefero is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# InDefero is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
#
# ***** END LICENSE BLOCK ***** */
/**
* This classes is a plugin which allows to synchronise access rights
* between indefero and monotone usher setups.
*/
class IDF_Plugin_SyncMonotone
{
/**
* Entry point of the plugin.
*/
static public function entry($signal, &$params)
{
$plug = new IDF_Plugin_SyncMonotone();
switch ($signal) {
case 'IDF_Project::created':
$plug->processMonotoneCreate($params['project']);
break;
- initial work on a mtn-post-push script which updates IDF's timeline when new revisions arrive. this still needs some more tests, but its a start. - refactor out the monotonerc template from SyncMonotone.php and place it in a separate template file (access control hooks are still missing from there)
2010-08-30 11:20:47 +00:00
case 'mtnpostpush.php::run':
$plug->processSyncTimeline($params);
break;
First attempt on a monotone plugin which creates a new database upon project creation and adds the new server to the running usher instance. If everything goes well, the usher instance is told to reload its configuration, so the new server / database is picked up and started automatically.
2010-08-28 23:10:08 +00:00
}
}
/**
- now that we have to configure usher's configuration file anyway, we can skip the explicit configuration of its host and admin password, as we can directly read that from the configuration file itself - expand the SyncMonotone plugin a bit to where this actually becomes useful, i.e. create an accompanying key for each created database and also add some initial database-specific configuration - update the config docs in idf.php-dist to reflect the changes and add more details about the inner workings of the SyncMonotone plugin
2010-08-29 23:01:25 +00:00
* Four steps to setup a new monotone project:
*
* 1) run mtn db init to initialize a new database underknees
* 'mtn_repositories'
* 2) create a new server key in the same directory
* 3) write monotonerc for access control
* 4) add the database as new local server in the usher configuration
* 5) reload the running usher instance so it acknowledges the new
* server
First attempt on a monotone plugin which creates a new database upon project creation and adds the new server to the running usher instance. If everything goes well, the usher instance is told to reload its configuration, so the new server / database is picked up and started automatically.
2010-08-28 23:10:08 +00:00
*
* @param IDF_Project
*/
function processMonotoneCreate($project)
{
if ($project->getConf()->getVal('scm') != 'mtn') {
return;
}
- now that we have to configure usher's configuration file anyway, we can skip the explicit configuration of its host and admin password, as we can directly read that from the configuration file itself - expand the SyncMonotone plugin a bit to where this actually becomes useful, i.e. create an accompanying key for each created database and also add some initial database-specific configuration - update the config docs in idf.php-dist to reflect the changes and add more details about the inner workings of the SyncMonotone plugin
2010-08-29 23:01:25 +00:00
$projecttempl = Pluf::f('mtn_repositories', false);
if ($projecttempl === false) {
First attempt on a monotone plugin which creates a new database upon project creation and adds the new server to the running usher instance. If everything goes well, the usher instance is told to reload its configuration, so the new server / database is picked up and started automatically.
2010-08-28 23:10:08 +00:00
throw new IDF_Scm_Exception(
'"mtn_repositories" must be defined in your configuration file.'
);
}
- now that we have to configure usher's configuration file anyway, we can skip the explicit configuration of its host and admin password, as we can directly read that from the configuration file itself - expand the SyncMonotone plugin a bit to where this actually becomes useful, i.e. create an accompanying key for each created database and also add some initial database-specific configuration - update the config docs in idf.php-dist to reflect the changes and add more details about the inner workings of the SyncMonotone plugin
2010-08-29 23:01:25 +00:00
$usher_config = Pluf::f('mtn_usher_conf', false);
if (!$usher_config || !is_writable($usher_config)) {
First attempt on a monotone plugin which creates a new database upon project creation and adds the new server to the running usher instance. If everything goes well, the usher instance is told to reload its configuration, so the new server / database is picked up and started automatically.
2010-08-28 23:10:08 +00:00
throw new IDF_Scm_Exception(
- now that we have to configure usher's configuration file anyway, we can skip the explicit configuration of its host and admin password, as we can directly read that from the configuration file itself - expand the SyncMonotone plugin a bit to where this actually becomes useful, i.e. create an accompanying key for each created database and also add some initial database-specific configuration - update the config docs in idf.php-dist to reflect the changes and add more details about the inner workings of the SyncMonotone plugin
2010-08-29 23:01:25 +00:00
'"mtn_usher_conf" does not exist or is not writable.'
First attempt on a monotone plugin which creates a new database upon project creation and adds the new server to the running usher instance. If everything goes well, the usher instance is told to reload its configuration, so the new server / database is picked up and started automatically.
2010-08-28 23:10:08 +00:00
);
}
- initial work on a mtn-post-push script which updates IDF's timeline when new revisions arrive. this still needs some more tests, but its a start. - refactor out the monotonerc template from SyncMonotone.php and place it in a separate template file (access control hooks are still missing from there)
2010-08-30 11:20:47 +00:00
$mtnpostpush = realpath(dirname(__FILE__) . "/../../../scripts/mtn-post-push");
if (!file_exists($mtnpostpush)) {
throw new IDF_Scm_Exception(sprintf(
__('Could not find mtn-post-push script "%s".'), $mtnpostpush
));
}
First attempt on a monotone plugin which creates a new database upon project creation and adds the new server to the running usher instance. If everything goes well, the usher instance is told to reload its configuration, so the new server / database is picked up and started automatically.
2010-08-28 23:10:08 +00:00
$shortname = $project->shortname;
- now that we have to configure usher's configuration file anyway, we can skip the explicit configuration of its host and admin password, as we can directly read that from the configuration file itself - expand the SyncMonotone plugin a bit to where this actually becomes useful, i.e. create an accompanying key for each created database and also add some initial database-specific configuration - update the config docs in idf.php-dist to reflect the changes and add more details about the inner workings of the SyncMonotone plugin
2010-08-29 23:01:25 +00:00
$projectpath = sprintf($projecttempl, $shortname);
if (file_exists($projectpath)) {
throw new IDF_Scm_Exception(sprintf(
__('The project path %s already exists.'), $projectpath
));
}
if (!mkdir($projectpath)) {
First attempt on a monotone plugin which creates a new database upon project creation and adds the new server to the running usher instance. If everything goes well, the usher instance is told to reload its configuration, so the new server / database is picked up and started automatically.
2010-08-28 23:10:08 +00:00
throw new IDF_Scm_Exception(sprintf(
- now that we have to configure usher's configuration file anyway, we can skip the explicit configuration of its host and admin password, as we can directly read that from the configuration file itself - expand the SyncMonotone plugin a bit to where this actually becomes useful, i.e. create an accompanying key for each created database and also add some initial database-specific configuration - update the config docs in idf.php-dist to reflect the changes and add more details about the inner workings of the SyncMonotone plugin
2010-08-29 23:01:25 +00:00
__('The project path %s could not be created.'), $projectpath
First attempt on a monotone plugin which creates a new database upon project creation and adds the new server to the running usher instance. If everything goes well, the usher instance is told to reload its configuration, so the new server / database is picked up and started automatically.
2010-08-28 23:10:08 +00:00
));
}
- now that we have to configure usher's configuration file anyway, we can skip the explicit configuration of its host and admin password, as we can directly read that from the configuration file itself - expand the SyncMonotone plugin a bit to where this actually becomes useful, i.e. create an accompanying key for each created database and also add some initial database-specific configuration - update the config docs in idf.php-dist to reflect the changes and add more details about the inner workings of the SyncMonotone plugin
2010-08-29 23:01:25 +00:00
//
// step 1) create a new database
//
$dbfile = $projectpath.'/database.mtn';
First attempt on a monotone plugin which creates a new database upon project creation and adds the new server to the running usher instance. If everything goes well, the usher instance is told to reload its configuration, so the new server / database is picked up and started automatically.
2010-08-28 23:10:08 +00:00
$cmd = sprintf(
Pluf::f('mtn_path', 'mtn').' db init -d %s',
escapeshellarg($dbfile)
);
$cmd = Pluf::f('idf_exec_cmd_prefix', '').$cmd;
- PHP doesn't like the $var = <init> kind of initialization and won't return variable references properly, so revert that change again - since we're requiring 0.99 now, we also have to use au generate_key instead of au genkey
2010-08-30 13:46:05 +00:00
$output = $return = null;
$ll = exec($cmd, $output, $return);
- now that we have to configure usher's configuration file anyway, we can skip the explicit configuration of its host and admin password, as we can directly read that from the configuration file itself - expand the SyncMonotone plugin a bit to where this actually becomes useful, i.e. create an accompanying key for each created database and also add some initial database-specific configuration - update the config docs in idf.php-dist to reflect the changes and add more details about the inner workings of the SyncMonotone plugin
2010-08-29 23:01:25 +00:00
if ($return != 0) {
throw new IDF_Scm_Exception(sprintf(
__('The database file %s could not be created.'), $dbfile
));
}
//
// step 2) create a server key
//
// try to parse the key's domain part from the remote_url's host
// name, otherwise fall back to the configured Apache server name
$server = $_SERVER['SERVER_NAME'];
$remote_url = Pluf::f('mtn_remote_url');
if (($parsed = parse_url($remote_url)) !== false &&
!empty($parsed['host'])) {
$server = $parsed['host'];
}
$keyname = $shortname.'-server@'.$server;
$cmd = sprintf(
- PHP doesn't like the $var = <init> kind of initialization and won't return variable references properly, so revert that change again - since we're requiring 0.99 now, we also have to use au generate_key instead of au genkey
2010-08-30 13:46:05 +00:00
Pluf::f('mtn_path', 'mtn').' au generate_key --confdir=%s %s ""',
- now that we have to configure usher's configuration file anyway, we can skip the explicit configuration of its host and admin password, as we can directly read that from the configuration file itself - expand the SyncMonotone plugin a bit to where this actually becomes useful, i.e. create an accompanying key for each created database and also add some initial database-specific configuration - update the config docs in idf.php-dist to reflect the changes and add more details about the inner workings of the SyncMonotone plugin
2010-08-29 23:01:25 +00:00
escapeshellarg($projectpath),
escapeshellarg($keyname)
);
- PHP doesn't like the $var = <init> kind of initialization and won't return variable references properly, so revert that change again - since we're requiring 0.99 now, we also have to use au generate_key instead of au genkey
2010-08-30 13:46:05 +00:00
- now that we have to configure usher's configuration file anyway, we can skip the explicit configuration of its host and admin password, as we can directly read that from the configuration file itself - expand the SyncMonotone plugin a bit to where this actually becomes useful, i.e. create an accompanying key for each created database and also add some initial database-specific configuration - update the config docs in idf.php-dist to reflect the changes and add more details about the inner workings of the SyncMonotone plugin
2010-08-29 23:01:25 +00:00
$cmd = Pluf::f('idf_exec_cmd_prefix', '').$cmd;
- PHP doesn't like the $var = <init> kind of initialization and won't return variable references properly, so revert that change again - since we're requiring 0.99 now, we also have to use au generate_key instead of au genkey
2010-08-30 13:46:05 +00:00
$output = $return = null;
$ll = exec($cmd, $output, $return);
First attempt on a monotone plugin which creates a new database upon project creation and adds the new server to the running usher instance. If everything goes well, the usher instance is told to reload its configuration, so the new server / database is picked up and started automatically.
2010-08-28 23:10:08 +00:00
if ($return != 0) {
throw new IDF_Scm_Exception(sprintf(
- now that we have to configure usher's configuration file anyway, we can skip the explicit configuration of its host and admin password, as we can directly read that from the configuration file itself - expand the SyncMonotone plugin a bit to where this actually becomes useful, i.e. create an accompanying key for each created database and also add some initial database-specific configuration - update the config docs in idf.php-dist to reflect the changes and add more details about the inner workings of the SyncMonotone plugin
2010-08-29 23:01:25 +00:00
__('The server key %s could not be created.'), $keyname
First attempt on a monotone plugin which creates a new database upon project creation and adds the new server to the running usher instance. If everything goes well, the usher instance is told to reload its configuration, so the new server / database is picked up and started automatically.
2010-08-28 23:10:08 +00:00
));
}
- now that we have to configure usher's configuration file anyway, we can skip the explicit configuration of its host and admin password, as we can directly read that from the configuration file itself - expand the SyncMonotone plugin a bit to where this actually becomes useful, i.e. create an accompanying key for each created database and also add some initial database-specific configuration - update the config docs in idf.php-dist to reflect the changes and add more details about the inner workings of the SyncMonotone plugin
2010-08-29 23:01:25 +00:00
//
// step 3) write monotonerc for access control
// FIXME: netsync access control is still missing!
- initial work on a mtn-post-push script which updates IDF's timeline when new revisions arrive. this still needs some more tests, but its a start. - refactor out the monotonerc template from SyncMonotone.php and place it in a separate template file (access control hooks are still missing from there)
2010-08-30 11:20:47 +00:00
//
$monotonerc = file_get_contents(dirname(__FILE__) . "/SyncMonotone/monotonerc.tpl");
$monotonerc = str_replace(
array("%%MTNPOSTPUSH%%", "%%PROJECT%%"),
array($mtnpostpush, $shortname),
$monotonerc
);
- now that we have to configure usher's configuration file anyway, we can skip the explicit configuration of its host and admin password, as we can directly read that from the configuration file itself - expand the SyncMonotone plugin a bit to where this actually becomes useful, i.e. create an accompanying key for each created database and also add some initial database-specific configuration - update the config docs in idf.php-dist to reflect the changes and add more details about the inner workings of the SyncMonotone plugin
2010-08-29 23:01:25 +00:00
$rcfile = $projectpath.'/monotonerc';
simplify and harden the configuration file writeouts, didn't knew file_put_contents was around for so long already...
2010-08-30 07:00:20 +00:00
if (!file_put_contents($rcfile, $monotonerc, LOCK_EX)) {
throw new IDF_Scm_Exception(sprintf(
- initial work on a mtn-post-push script which updates IDF's timeline when new revisions arrive. this still needs some more tests, but its a start. - refactor out the monotonerc template from SyncMonotone.php and place it in a separate template file (access control hooks are still missing from there)
2010-08-30 11:20:47 +00:00
__('Could not write mtn configuration file "%s"'), $rcfile
simplify and harden the configuration file writeouts, didn't knew file_put_contents was around for so long already...
2010-08-30 07:00:20 +00:00
));
}
- now that we have to configure usher's configuration file anyway, we can skip the explicit configuration of its host and admin password, as we can directly read that from the configuration file itself - expand the SyncMonotone plugin a bit to where this actually becomes useful, i.e. create an accompanying key for each created database and also add some initial database-specific configuration - update the config docs in idf.php-dist to reflect the changes and add more details about the inner workings of the SyncMonotone plugin
2010-08-29 23:01:25 +00:00
//
// step 4) read in and append the usher config with the new server
//
$usher_rc = file_get_contents($usher_config);
First attempt on a monotone plugin which creates a new database upon project creation and adds the new server to the running usher instance. If everything goes well, the usher instance is told to reload its configuration, so the new server / database is picked up and started automatically.
2010-08-28 23:10:08 +00:00
$parsed_config = array();
try {
$parsed_config = IDF_Scm_Monotone_BasicIO::parse($usher_rc);
}
catch (Exception $e) {
throw new IDF_Scm_Exception(sprintf(
__('Could not parse usher configuration in "%s": %s'),
- now that we have to configure usher's configuration file anyway, we can skip the explicit configuration of its host and admin password, as we can directly read that from the configuration file itself - expand the SyncMonotone plugin a bit to where this actually becomes useful, i.e. create an accompanying key for each created database and also add some initial database-specific configuration - update the config docs in idf.php-dist to reflect the changes and add more details about the inner workings of the SyncMonotone plugin
2010-08-29 23:01:25 +00:00
$usher_config, $e->getMessage()
First attempt on a monotone plugin which creates a new database upon project creation and adds the new server to the running usher instance. If everything goes well, the usher instance is told to reload its configuration, so the new server / database is picked up and started automatically.
2010-08-28 23:10:08 +00:00
));
}
// ensure we haven't configured a server with this name already
foreach ($parsed_config as $stanzas)
{
foreach ($stanzas as $stanza_line)
{
if ($stanza_line['key'] == 'server' &&
$stanza_line['values'][0] == $shortname)
{
throw new IDF_Scm_Exception(sprintf(
__('usher configuration already contains a server '.
'entry named "%s"'),
$shortname
));
}
}
}
$new_server = array(
array('key' => 'server', 'values' => array($shortname)),
- now that we have to configure usher's configuration file anyway, we can skip the explicit configuration of its host and admin password, as we can directly read that from the configuration file itself - expand the SyncMonotone plugin a bit to where this actually becomes useful, i.e. create an accompanying key for each created database and also add some initial database-specific configuration - update the config docs in idf.php-dist to reflect the changes and add more details about the inner workings of the SyncMonotone plugin
2010-08-29 23:01:25 +00:00
array('key' => 'local', 'values' => array(
'--confdir', $projectpath,
'-d', $dbfile
)),
First attempt on a monotone plugin which creates a new database upon project creation and adds the new server to the running usher instance. If everything goes well, the usher instance is told to reload its configuration, so the new server / database is picked up and started automatically.
2010-08-28 23:10:08 +00:00
);
$parsed_config[] = $new_server;
$usher_rc = IDF_Scm_Monotone_BasicIO::compile($parsed_config);
simplify and harden the configuration file writeouts, didn't knew file_put_contents was around for so long already...
2010-08-30 07:00:20 +00:00
// FIXME: more sanity - what happens on failing writes? we do not
// have a backup copy of usher.conf around...
if (!file_put_contents($usher_config, $usher_rc, LOCK_EX)) {
throw new IDF_Scm_Exception(sprintf(
- initial work on a mtn-post-push script which updates IDF's timeline when new revisions arrive. this still needs some more tests, but its a start. - refactor out the monotonerc template from SyncMonotone.php and place it in a separate template file (access control hooks are still missing from there)
2010-08-30 11:20:47 +00:00
__('Could not write usher configuration file "%s"'), $usher_config
simplify and harden the configuration file writeouts, didn't knew file_put_contents was around for so long already...
2010-08-30 07:00:20 +00:00
));
}
First attempt on a monotone plugin which creates a new database upon project creation and adds the new server to the running usher instance. If everything goes well, the usher instance is told to reload its configuration, so the new server / database is picked up and started automatically.
2010-08-28 23:10:08 +00:00
- now that we have to configure usher's configuration file anyway, we can skip the explicit configuration of its host and admin password, as we can directly read that from the configuration file itself - expand the SyncMonotone plugin a bit to where this actually becomes useful, i.e. create an accompanying key for each created database and also add some initial database-specific configuration - update the config docs in idf.php-dist to reflect the changes and add more details about the inner workings of the SyncMonotone plugin
2010-08-29 23:01:25 +00:00
//
// step 5) reload usher to pick up the new configuration
//
First attempt on a monotone plugin which creates a new database upon project creation and adds the new server to the running usher instance. If everything goes well, the usher instance is told to reload its configuration, so the new server / database is picked up and started automatically.
2010-08-28 23:10:08 +00:00
IDF_Scm_Monotone_Usher::reload();
}
- initial work on a mtn-post-push script which updates IDF's timeline when new revisions arrive. this still needs some more tests, but its a start. - refactor out the monotonerc template from SyncMonotone.php and place it in a separate template file (access control hooks are still missing from there)
2010-08-30 11:20:47 +00:00
/**
* Update the timeline after a push
*
*/
public function processSyncTimeline($params)
{
$pname = $params['project'];
try {
$project = IDF_Project::getOr404($pname);
} catch (Pluf_HTTP_Error404 $e) {
Pluf_Log::event(array(
'IDF_Plugin_SyncMonotone::processSyncTimeline',
'Project not found.',
array($pname, $params)
));
return false; // Project not found
}
Pluf_Log::debug(array(
'IDF_Plugin_SyncMonotone::processSyncTimeline',
'Project found', $pname, $project->id
));
IDF_Scm::syncTimeline($project, true);
Pluf_Log::event(array(
'IDF_Plugin_SyncMonotone::processSyncTimeline',
'sync', array($pname, $project->id)
));
}
First attempt on a monotone plugin which creates a new database upon project creation and adds the new server to the running usher instance. If everything goes well, the usher instance is told to reload its configuration, so the new server / database is picked up and started automatically.
2010-08-28 23:10:08 +00:00
}
Reference in New Issue Copy Permalink