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

716 lines
26 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':
* configure whether or not to set remote client authentication for IDF -> remote_stdio * hook into IDF_Project::preDelete, IDF_Key::postSave and IDF_Key::preDelete * this is all not quite finished, but a big leap forward to completion
2010-09-13 00:53:24 +00:00
$plug->processProjectCreate($params['project']);
break;
case 'IDF_Project::preDelete':
$plug->processProjectDelete($params['project']);
break;
case 'IDF_Key::postSave':
$plug->processKeyCreate($params['key']);
break;
case 'IDF_Key::preDelete':
$plug->processKeyDelete($params['key']);
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
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':
* configure whether or not to set remote client authentication for IDF -> remote_stdio * hook into IDF_Project::preDelete, IDF_Key::postSave and IDF_Key::preDelete * this is all not quite finished, but a big leap forward to completion
2010-09-13 00:53:24 +00:00
$plug->processSyncTimeline($params['project']);
- 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
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
}
}
/**
* configure whether or not to set remote client authentication for IDF -> remote_stdio * hook into IDF_Project::preDelete, IDF_Key::postSave and IDF_Key::preDelete * this is all not quite finished, but a big leap forward to completion
2010-09-13 00:53:24 +00:00
* Initial steps to setup a new monotone project:
- 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
*
* 1) run mtn db init to initialize a new database underknees
* 'mtn_repositories'
* 2) create a new server key in the same directory
* configure whether or not to set remote client authentication for IDF -> remote_stdio * hook into IDF_Project::preDelete, IDF_Key::postSave and IDF_Key::preDelete * this is all not quite finished, but a big leap forward to completion
2010-09-13 00:53:24 +00:00
* 3) create a new client key for IDF and store it in the project conf
* 4) write monotonerc
* 5) add the database as new local server in the usher configuration
* 6) reload the running usher instance so it acknowledges the new server
* 7) create read-/write-permissions for the project and add all public
* keys to the project
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
*/
* configure whether or not to set remote client authentication for IDF -> remote_stdio * hook into IDF_Project::preDelete, IDF_Key::postSave and IDF_Key::preDelete * this is all not quite finished, but a big leap forward to completion
2010-09-13 00:53:24 +00:00
function processProjectCreate($project)
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 ($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
));
}
* configure whether or not to set remote client authentication for IDF -> remote_stdio * hook into IDF_Project::preDelete, IDF_Key::postSave and IDF_Key::preDelete * this is all not quite finished, but a big leap forward to completion
2010-09-13 00:53:24 +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
$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';
* configure whether or not to set remote client authentication for IDF -> remote_stdio * hook into IDF_Project::preDelete, IDF_Key::postSave and IDF_Key::preDelete * this is all not quite finished, but a big leap forward to completion
2010-09-13 00:53:24 +00:00
$cmd = sprintf('db init -d %s', escapeshellarg($dbfile));
self::_mtn_exec($cmd);
- 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 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'];
}
* configure whether or not to set remote client authentication for IDF -> remote_stdio * hook into IDF_Project::preDelete, IDF_Key::postSave and IDF_Key::preDelete * this is all not quite finished, but a big leap forward to completion
2010-09-13 00:53:24 +00:00
$serverkey = $shortname.'-server@'.$server;
$cmd = sprintf('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),
* configure whether or not to set remote client authentication for IDF -> remote_stdio * hook into IDF_Project::preDelete, IDF_Key::postSave and IDF_Key::preDelete * this is all not quite finished, but a big leap forward to completion
2010-09-13 00:53:24 +00:00
escapeshellarg($serverkey)
- 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
);
* configure whether or not to set remote client authentication for IDF -> remote_stdio * hook into IDF_Project::preDelete, IDF_Key::postSave and IDF_Key::preDelete * this is all not quite finished, but a big leap forward to completion
2010-09-13 00:53:24 +00:00
self::_mtn_exec($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
* configure whether or not to set remote client authentication for IDF -> remote_stdio * hook into IDF_Project::preDelete, IDF_Key::postSave and IDF_Key::preDelete * this is all not quite finished, but a big leap forward to completion
2010-09-13 00:53:24 +00:00
//
// step 3) create a client key, and save it in IDF
//
$clientkey_hash = '';
$monotonerc_tpl = 'monotonerc-noauth.tpl';
if (Pluf::f('mtn_remote_auth', true)) {
$monotonerc_tpl = 'monotonerc-auth.tpl';
$keydir = Pluf::f('tmp_folder').'/mtn-client-keys';
if (!file_exists($keydir)) {
if (!mkdir($keydir)) {
throw new IDF_Scm_Exception(sprintf(
__('The key directory %s could not be created.'), $keydir
));
}
}
$clientkey_name = $shortname.'-client@'.$server;
$cmd = sprintf('au generate_key --keydir=%s %s ""',
escapeshellarg($keydir),
escapeshellarg($clientkey_name)
);
$keyinfo = self::_mtn_exec($cmd);
$parsed_keyinfo = array();
try {
$parsed_keyinfo = IDF_Scm_Monotone_BasicIO::parse($keyinfo);
}
catch (Exception $e) {
echo $e->getTraceAsString(); exit;
throw new IDF_Scm_Exception(sprintf(
__('Could not parse key information: %s'), $e->getMessage()
));
}
$clientkey_hash = $parsed_keyinfo[0][1]['hash'];
$clientkey_file = $keydir . '/' . $clientkey_name . '.' . $clientkey_hash;
$clientkey_data = file_get_contents($clientkey_file);
$project->getConf()->setVal('mtn_client_key_name', $clientkey_name);
$project->getConf()->setVal('mtn_client_key_hash', $clientkey_hash);
$project->getConf()->setVal('mtn_client_key_data', $clientkey_data);
// add the public client key to the server
$cmd = sprintf('au get_public_key --keydir=%s %s',
escapeshellarg($keydir),
escapeshellarg($clientkey_hash)
);
$clientkey_pubdata = self::_mtn_exec($cmd);
$cmd = sprintf('au put_public_key --confdir=%s %s',
escapeshellarg($projectpath),
escapeshellarg($clientkey_pubdata)
);
$keyinfo = self::_mtn_exec($cmd);
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
//
* configure whether or not to set remote client authentication for IDF -> remote_stdio * hook into IDF_Project::preDelete, IDF_Key::postSave and IDF_Key::preDelete * this is all not quite finished, but a big leap forward to completion
2010-09-13 00:53:24 +00:00
// step 4) write monotonerc
//
$monotonerc = file_get_contents(
dirname(__FILE__).'/SyncMonotone/'.$monotonerc_tpl
);
- 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 = str_replace(
* configure whether or not to set remote client authentication for IDF -> remote_stdio * hook into IDF_Project::preDelete, IDF_Key::postSave and IDF_Key::preDelete * this is all not quite finished, but a big leap forward to completion
2010-09-13 00:53:24 +00:00
array('%%MTNPOSTPUSH%%', '%%PROJECT%%', '%%MTNCLIENTKEY%%'),
array($mtnpostpush, $shortname, $clientkey_hash),
- 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
);
- 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';
* configure whether or not to set remote client authentication for IDF -> remote_stdio * hook into IDF_Project::preDelete, IDF_Key::postSave and IDF_Key::preDelete * this is all not quite finished, but a big leap forward to completion
2010-09-13 00:53:24 +00:00
if (file_put_contents($rcfile, $monotonerc, LOCK_EX) === false) {
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
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
//
* configure whether or not to set remote client authentication for IDF -> remote_stdio * hook into IDF_Project::preDelete, IDF_Key::postSave and IDF_Key::preDelete * this is all not quite finished, but a big leap forward to completion
2010-09-13 00:53:24 +00:00
// step 5) read in and append the usher config with the new server
- 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_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
* configure whether or not to set remote client authentication for IDF -> remote_stdio * hook into IDF_Project::preDelete, IDF_Key::postSave and IDF_Key::preDelete * this is all not quite finished, but a big leap forward to completion
2010-09-13 00:53:24 +00:00
foreach ($parsed_config as $stanzas) {
foreach ($stanzas as $stanza_line) {
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 ($stanza_line['key'] == 'server' &&
* configure whether or not to set remote client authentication for IDF -> remote_stdio * hook into IDF_Project::preDelete, IDF_Key::postSave and IDF_Key::preDelete * this is all not quite finished, but a big leap forward to completion
2010-09-13 00:53:24 +00:00
$stanza_line['values'][0] == $shortname) {
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(
__('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...
* configure whether or not to set remote client authentication for IDF -> remote_stdio * hook into IDF_Project::preDelete, IDF_Key::postSave and IDF_Key::preDelete * this is all not quite finished, but a big leap forward to completion
2010-09-13 00:53:24 +00:00
if (file_put_contents($usher_config, $usher_rc, LOCK_EX) === false) {
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
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
//
* configure whether or not to set remote client authentication for IDF -> remote_stdio * hook into IDF_Project::preDelete, IDF_Key::postSave and IDF_Key::preDelete * this is all not quite finished, but a big leap forward to completion
2010-09-13 00:53:24 +00:00
// step 6) reload usher to pick up the new configuration
- 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
//
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();
* configure whether or not to set remote client authentication for IDF -> remote_stdio * hook into IDF_Project::preDelete, IDF_Key::postSave and IDF_Key::preDelete * this is all not quite finished, but a big leap forward to completion
2010-09-13 00:53:24 +00:00
//
// step 7) add public monotone keys for the project to
// read-permissions, write-permissions and the database
//
$mtn = IDF_Scm_Monotone::factory($project);
$stdio = $mtn->getStdio();
$auth_ids = self::getAuthorizedUserIds($project);
$key_ids = array();
foreach ($auth_ids as $auth_id) {
$sql = new Pluf_SQL('user=%s', array($auth_id));
$keys = Pluf::factory('IDF_Key')->getList(array('filter' => $sql->gen()));
foreach ($keys as $key) {
if ($key->getType() != 'mtn')
continue;
$stdio->exec(array('put_public_key', $key->content));
$key_ids[] = $key->getMtnId();
}
}
$write_permissions = implode("\n", $key_ids);
$rcfile = $projectpath.'/write-permissions';
if (file_put_contents($rcfile, $write_permissions, LOCK_EX) === false) {
throw new IDF_Scm_Exception(sprintf(
__('Could not write write-permissions file "%s"'), $rcfile
));
}
if ($project->private) {
$stanza = array(
array('key' => 'pattern', 'values' => array('*')),
);
foreach ($key_ids as $key_id)
{
$stanza[] = array('key' => 'allow', 'values' => array($key_id));
}
}
else {
$stanza = array(
array('key' => 'pattern', 'values' => array('*')),
array('key' => 'allow', 'values' => array('*')),
);
}
$read_permissions = IDF_Scm_Monotone_BasicIO::compile(array($stanza));
$rcfile = $projectpath.'/read-permissions';
if (file_put_contents($rcfile, $read_permissions, LOCK_EX) === false) {
throw new IDF_Scm_Exception(sprintf(
__('Could not write read-permissions file "%s"'), $rcfile
));
}
}
/**
* Clean up after a mtn project was deleted
*
* @param IDF_Project
*/
public function processProjectDelete($project)
{
if ($project->getConf()->getVal('scm') != 'mtn') {
return;
}
$usher_config = Pluf::f('mtn_usher_conf', false);
if (!$usher_config || !is_writable($usher_config)) {
throw new IDF_Scm_Exception(
'"mtn_usher_conf" does not exist or is not writable.'
);
}
$shortname = $project->shortname;
IDF_Scm_Monotone_Usher::killServer($shortname);
$projecttempl = Pluf::f('mtn_repositories', false);
if ($projecttempl === false) {
throw new IDF_Scm_Exception(
'"mtn_repositories" must be defined in your configuration file.'
);
}
$usher_config = Pluf::f('mtn_usher_conf', false);
if (!$usher_config || !is_writable($usher_config)) {
throw new IDF_Scm_Exception(
'"mtn_usher_conf" does not exist or is not writable.'
);
}
$projectpath = sprintf($projecttempl, $shortname);
if (file_exists($projectpath)) {
if (!self::_delete_recursive($projectpath)) {
throw new IDF_Scm_Exception(sprintf(
__('One or more paths underknees %s could not be deleted.'), $projectpath
));
}
}
if (Pluf::f('mtn_remote_auth', true)) {
$keydir = Pluf::f('tmp_folder').'/mtn-client-keys';
$keyname = $project->getConf()->getVal('mtn_client_key_name', false);
$keyhash = $project->getConf()->getVal('mtn_client_key_hash', false);
if ($keyname && $keyhash &&
file_exists($keydir .'/'. $keyname . '.' . $keyhash)) {
if (!@unlink($keydir .'/'. $keyname . '.' . $keyhash)) {
throw new IDF_Scm_Exception(sprintf(
__('Could not delete client private key %s'), $keyname
));
}
}
}
$usher_rc = file_get_contents($usher_config);
$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'),
$usher_config, $e->getMessage()
));
}
foreach ($parsed_config as $idx => $stanzas) {
foreach ($stanzas as $stanza_line) {
if ($stanza_line['key'] == 'server' &&
$stanza_line['values'][0] == $shortname) {
unset($parsed_config[$idx]);
break;
}
}
}
$usher_rc = IDF_Scm_Monotone_BasicIO::compile($parsed_config);
// 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) === false) {
throw new IDF_Scm_Exception(sprintf(
__('Could not write usher configuration file "%s"'), $usher_config
));
}
IDF_Scm_Monotone_Usher::reload();
}
/**
* Adds the (monotone) key to all monotone projects of this forge
* where the user of the key has write access to
*/
public function processKeyCreate($key)
{
if ($key->getType() != 'mtn')
return;
$projecttempl = Pluf::f('mtn_repositories', false);
if ($projecttempl === false) {
throw new IDF_Scm_Exception(
'"mtn_repositories" must be defined in your configuration file.'
);
}
foreach (Pluf::factory('IDF_Project')->getList() as $project) {
$conf = new IDF_Conf();
$conf->setProject($project);
$scm = $conf->getVal('scm', 'mtn');
if ($scm != 'mtn')
continue;
$shortname = $project->shortname;
$projectpath = sprintf($projecttempl, $shortname);
if (!file_exists($projectpath)) {
throw new IDF_Scm_Exception(sprintf(
__('The project path %s does not exists.'), $projectpath
));
}
$auth_ids = self::getAuthorizedUserIds($project);
if (!in_array($key->user, $auth_ids))
continue;
$mtn_key_id = $key->getMtnId();
// if the project is not defined as private, all people have
// read access already, so we don't need to write anything
// and we currently do not check if read-permissions really
// contains
// pattern "*"
// allow "*"
// which is the default for non-private projects
if ($project->private == true) {
$read_perms = file_get_contents($projectpath.'/read-permissions');
$parsed_read_perms = array();
try {
$parsed_read_perms = IDF_Scm_Monotone_BasicIO::parse($read_perms);
}
catch (Exception $e) {
throw new IDF_Scm_Exception(sprintf(
__('Could not parse read-permissions for project "%s": %s'),
$shortname, $e->getMessage()
));
}
$wildcard_section = null;
foreach ($parsed_read_perms as $stanzas) {
foreach ($stanzas as $stanza_line) {
if ($stanza_line['key'] == 'pattern' &&
$stanza_line['values'][0] == '*') {
$wildcard_section =& $stanzas;
break;
}
}
}
if ($wildcard_section == null)
{
$wildcard_section = array(
array('key' => 'pattern', 'values' => array('*'))
);
$parsed_read_perms[] =& $wildcard_section;
}
$key_found = false;
foreach ($wildcard_section as $line)
{
if ($line['key'] == 'allow' && $line['values'][0] == $mtn_key_id) {
$key_found = true;
break;
}
}
if (!$key_found) {
$wildcard_section[] = array(
'key' => 'allow', 'values' => array($mtn_key_id)
);
}
$read_perms = IDF_Scm_Monotone_BasicIO::compile($parsed_read_perms);
if (file_put_contents($projectpath.'/read-permissions',
$read_perms, LOCK_EX) === false) {
throw new IDF_Scm_Exception(sprintf(
__('Could not write read-permissions for project "%s"'), $shortname
));
}
}
$write_perms = file_get_contents($projectpath.'/write-permissions');
$lines = preg_split("/(\n|\r\n)/", $write_perms);
if (!in_array('*', $lines) && !in_array($mtn_key_id, $lines)) {
$lines[] = $mtn_key_id;
}
if (file_put_contents($projectpath.'/write-permissions',
implode("\n", $lines), LOCK_EX) === false) {
throw new IDF_Scm_Exception(sprintf(
__('Could not write write-permissions file for project "%s"'),
$shortname
));
}
$mtn = IDF_Scm_Monotone::factory($project);
$stdio = $mtn->getStdio();
$stdio->exec(array('put_public_key', $key->content));
}
}
/**
* Removes the (monotone) key from all monotone projects of this forge
* where the user of the key has write access to
*/
public function processKeyDelete($key)
{
if ($key->getType() != 'mtn')
return;
$projecttempl = Pluf::f('mtn_repositories', false);
if ($projecttempl === false) {
throw new IDF_Scm_Exception(
'"mtn_repositories" must be defined in your configuration file.'
);
}
foreach (Pluf::factory('IDF_Project')->getList() as $project) {
$conf = new IDF_Conf();
$conf->setProject($project);
$scm = $conf->getVal('scm', 'mtn');
if ($scm != 'mtn')
continue;
$shortname = $project->shortname;
$projectpath = sprintf($projecttempl, $shortname);
if (!file_exists($projectpath)) {
throw new IDF_Scm_Exception(sprintf(
__('The project path %s does not exists.'), $projectpath
));
}
$auth_ids = self::getAuthorizedUserIds($project);
if (!in_array($key->user, $auth_ids))
continue;
$mtn_key_id = $key->getMtnId();
// if the project is not defined as private, all people have
// read access already, so we don't need to write anything
// and we currently do not check if read-permissions really
// contains
// pattern "*"
// allow "*"
// which is the default for non-private projects
if ($project->private === true) {
$read_perms = file_get_contents($projectpath.'/read-permissions');
$parsed_read_perms = array();
try {
$parsed_read_perms = IDF_Scm_Monotone_BasicIO::parse($read_perms);
}
catch (Exception $e) {
throw new IDF_Scm_Exception(sprintf(
__('Could not parse read-permissions for project "%s": %s'),
$shortname, $e->getMessage()
));
}
// while we add new keys only to an existing wild-card entry
// we remove dropped keys from all sections since the key
// should be simply unavailable for all of them
foreach ($parsed_read_perms as $stanzas) {
for ($i=0; $i<count($stanzas); ) {
if ($stanzas[$i]['key'] == 'allow' &&
$stanzas[$i]['values'][0] == $mtn_key_id) {
unset($stanzas[$i]);
continue;
}
++$i;
}
}
$read_perms = IDF_Scm_Monotone_BasicIO::compile($parsed_read_perms);
if (file_put_contents($projectpath.'/read-permissions',
$read_perms, LOCK_EX) === false) {
throw new IDF_Scm_Exception(sprintf(
__('Could not write read-permissions for project "%s"'), $shortname
));
}
}
$write_perms = file_get_contents($projectpath.'/write-permissions');
$lines = preg_split("/(\n|\r\n)/", $write_perms);
for ($i=0; $i<count($lines); ) {
if ($lines[$i] == $mtn_key_id) {
unset($lines[$i]);
continue;
}
++$i;
}
if (file_put_contents($projectpath.'/write-permissions',
implode("\n", $lines), LOCK_EX) === false) {
throw new IDF_Scm_Exception(sprintf(
__('Could not write write-permissions file for project "%s"'),
$shortname
));
}
$mtn = IDF_Scm_Monotone::factory($project);
$stdio = $mtn->getStdio();
// if the public key did not sign any revisions, drop it from
// the database as well
if (strlen($stdio->exec(array('select', 'k:' . $mtn_key_id))) == 0) {
$stdio->exec(array('drop_public_key', $mtn_key_id));
}
}
}
private static function getAuthorizedUserIds($project)
{
$mem = $project->getMembershipData();
$members = array_merge((array)$mem['members'],
(array)$mem['owners'],
(array)$mem['authorized']);
$userids = array();
foreach ($members as $member) {
$userids[] = $member->id;
}
return $userids;
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
/**
* Update the timeline after a push
*
*/
* configure whether or not to set remote client authentication for IDF -> remote_stdio * hook into IDF_Project::preDelete, IDF_Key::postSave and IDF_Key::preDelete * this is all not quite finished, but a big leap forward to completion
2010-09-13 00:53:24 +00:00
public function processSyncTimeline($project_name)
- 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
{
try {
* configure whether or not to set remote client authentication for IDF -> remote_stdio * hook into IDF_Project::preDelete, IDF_Key::postSave and IDF_Key::preDelete * this is all not quite finished, but a big leap forward to completion
2010-09-13 00:53:24 +00:00
$project = IDF_Project::getOr404($project_name);
- 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
} catch (Pluf_HTTP_Error404 $e) {
Pluf_Log::event(array(
* configure whether or not to set remote client authentication for IDF -> remote_stdio * hook into IDF_Project::preDelete, IDF_Key::postSave and IDF_Key::preDelete * this is all not quite finished, but a big leap forward to completion
2010-09-13 00:53:24 +00:00
'IDF_Plugin_SyncMonotone::processSyncTimeline',
- 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
'Project not found.',
* configure whether or not to set remote client authentication for IDF -> remote_stdio * hook into IDF_Project::preDelete, IDF_Key::postSave and IDF_Key::preDelete * this is all not quite finished, but a big leap forward to completion
2010-09-13 00:53:24 +00:00
array($project_name, $params)
- 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
));
return false; // Project not found
}
Pluf_Log::debug(array(
* configure whether or not to set remote client authentication for IDF -> remote_stdio * hook into IDF_Project::preDelete, IDF_Key::postSave and IDF_Key::preDelete * this is all not quite finished, but a big leap forward to completion
2010-09-13 00:53:24 +00:00
'IDF_Plugin_SyncMonotone::processSyncTimeline',
'Project found', $project_name, $project->id
- 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
));
IDF_Scm::syncTimeline($project, true);
Pluf_Log::event(array(
'IDF_Plugin_SyncMonotone::processSyncTimeline',
* configure whether or not to set remote client authentication for IDF -> remote_stdio * hook into IDF_Project::preDelete, IDF_Key::postSave and IDF_Key::preDelete * this is all not quite finished, but a big leap forward to completion
2010-09-13 00:53:24 +00:00
'sync', array($project_name, $project->id)
- 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
));
}
* configure whether or not to set remote client authentication for IDF -> remote_stdio * hook into IDF_Project::preDelete, IDF_Key::postSave and IDF_Key::preDelete * this is all not quite finished, but a big leap forward to completion
2010-09-13 00:53:24 +00:00
private static function _mtn_exec($cmd)
{
$fullcmd = sprintf('%s %s %s',
Pluf::f('idf_exec_cmd_prefix', ''),
Pluf::f('mtn_path', 'mtn'),
$cmd
);
$output = $return = null;
exec($fullcmd, $output, $return);
if ($return != 0) {
throw new IDF_Scm_Exception(sprintf(
__('The command "%s" could not be executed.'), $cmd
));
}
return implode("\n", $output);
}
private static function _delete_recursive($path)
{
if (is_file($path)) {
return @unlink($path);
}
if (is_dir($path)) {
$scan = glob(rtrim($path, '/') . '/*');
$status = 0;
foreach ($scan as $subpath) {
$status |= self::_delete_recursive($subpath);
}
$status |= rmdir($path);
return $status;
}
}
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
}