* Committing first version of SVN Backup Module

This is a module which allows you to periodically export a serialised version of your region to a SVN repository and store it there. It is still a work in progress and is currently disabled and incomplete, but some of the functionality is demonstratable.
* Enjoy.
0.6.0-stable
Adam Frisby 2008-04-17 11:42:06 +00:00
parent 4f41988ef7
commit 05708771bb
4 changed files with 208 additions and 6 deletions

View File

@ -12,19 +12,17 @@ using System.IO;
namespace OpenSim.Region.Environment.Modules.ExportSerialiser namespace OpenSim.Region.Environment.Modules.ExportSerialiser
{ {
public class ExportSerialisationModule : IRegionModule public class ExportSerialisationModule : IRegionModule, OpenSim.Region.Environment.Modules.ExportSerialiser.IRegionSerialiser
{ {
private List<Scene> m_regions = new List<Scene>(); private List<Scene> m_regions = new List<Scene>();
private List<IFileSerialiser> m_serialisers = new List<IFileSerialiser>(); private List<IFileSerialiser> m_serialisers = new List<IFileSerialiser>();
private Commander m_commander = new Commander("Export"); private Commander m_commander = new Commander("Export");
private string m_savedir = "exports" + "/"; private string m_savedir = "exports" + "/";
private List<string> SerialiseRegion(Scene scene) public List<string> SerialiseRegion(Scene scene, string saveDir)
{ {
List<string> results = new List<string>(); List<string> results = new List<string>();
string saveDir = m_savedir + scene.RegionInfo.RegionID.ToString() + "/";
if (!Directory.Exists(saveDir)) if (!Directory.Exists(saveDir))
{ {
Directory.CreateDirectory(saveDir); Directory.CreateDirectory(saveDir);
@ -62,6 +60,7 @@ namespace OpenSim.Region.Environment.Modules.ExportSerialiser
{ {
scene.RegisterModuleCommander("Export", m_commander); scene.RegisterModuleCommander("Export", m_commander);
scene.EventManager.OnPluginConsole += EventManager_OnPluginConsole; scene.EventManager.OnPluginConsole += EventManager_OnPluginConsole;
scene.RegisterModuleInterface<IRegionSerialiser>(this);
lock (m_regions) lock (m_regions)
{ {
@ -88,7 +87,7 @@ namespace OpenSim.Region.Environment.Modules.ExportSerialiser
{ {
if (region.RegionInfo.RegionName == (string)args[0]) if (region.RegionInfo.RegionName == (string)args[0])
{ {
List<string> results = SerialiseRegion(region); List<string> results = SerialiseRegion(region, m_savedir + region.RegionInfo.RegionID.ToString() + "/");
} }
} }
} }
@ -97,7 +96,7 @@ namespace OpenSim.Region.Environment.Modules.ExportSerialiser
{ {
foreach (Scene region in m_regions) foreach (Scene region in m_regions)
{ {
List<string> results = SerialiseRegion(region); List<string> results = SerialiseRegion(region, m_savedir + region.RegionInfo.RegionID.ToString() + "/");
} }
} }

View File

@ -0,0 +1,36 @@
using System.Reflection;
using System.Runtime.CompilerServices;
using System.Runtime.InteropServices;
// General Information about an assembly is controlled through the following
// set of attributes. Change these attribute values to modify the information
// associated with an assembly.
[assembly: AssemblyTitle("SvnSerialiser")]
[assembly: AssemblyDescription("")]
[assembly: AssemblyConfiguration("")]
[assembly: AssemblyCompany("")]
[assembly: AssemblyProduct("SvnSerialiser")]
[assembly: AssemblyCopyright("Copyright © 2008")]
[assembly: AssemblyTrademark("")]
[assembly: AssemblyCulture("")]
// Setting ComVisible to false makes the types in this assembly not visible
// to COM components. If you need to access a type in this assembly from
// COM, set the ComVisible attribute to true on that type.
[assembly: ComVisible(false)]
// The following GUID is for the ID of the typelib if this project is exposed to COM
[assembly: Guid("c0893655-0c18-4dd7-8b5b-5f58ab1ec6c7")]
// Version information for an assembly consists of the following four values:
//
// Major Version
// Minor Version
// Build Number
// Revision
//
// You can specify all the values or you can default the Build and Revision Numbers
// by using the '*' as shown below:
// [assembly: AssemblyVersion("1.0.*")]
[assembly: AssemblyVersion("1.0.0.0")]
[assembly: AssemblyFileVersion("1.0.0.0")]

View File

@ -0,0 +1,137 @@
using System;
using System.Collections.Generic;
using Nini.Config;
using OpenSim.Region.Environment.Interfaces;
using OpenSim.Region.Environment.Scenes;
using OpenSim.Region.Environment.Modules.ExportSerialiser;
using PumaCode.SvnDotNet.SubversionSharp;
using PumaCode.SvnDotNet.AprSharp;
namespace OpenSim.Region.Modules.SvnSerialiser
{
public class SvnBackupModule : IRegionModule
{
private static readonly log4net.ILog m_log = log4net.LogManager.GetLogger(System.Reflection.MethodBase.GetCurrentMethod().DeclaringType);
private SvnClient m_svnClient;
private bool m_installBackupOnLoad = false;
private string m_svnurl = "svn://url.tld/repository/";
private string m_svnuser = "user";
private string m_svnpass = "password";
private string m_svndir = "modsvn/";
private IRegionSerialiser m_serialiser;
private List<Scene> m_scenes = new List<Scene>();
#region SvnModule Core
public void SaveRegion(Scene scene)
{
List<string> filenames = m_serialiser.SerialiseRegion(scene, m_svndir);
foreach (string filename in filenames)
{
m_svnClient.Add3(filename, false, true, false);
}
m_svnClient.Commit3(filenames, true, false);
}
#endregion
#region SvnDotNet Callbacks
private SvnError SimpleAuth(out SvnAuthCredSimple svnCredentials, IntPtr baton,
AprString realm, AprString username, bool maySave, AprPool pool)
{
svnCredentials = SvnAuthCredSimple.Alloc(pool);
svnCredentials.Username = new AprString(m_svnuser, pool);
svnCredentials.Password = new AprString(m_svnpass, pool);
svnCredentials.MaySave = false;
return SvnError.NoError;
}
private SvnError GetCommitLogCallback(out AprString logMessage, out SvnPath tmpFile, AprArray commitItems, IntPtr baton, AprPool pool)
{
if (!commitItems.IsNull)
{
foreach (SvnClientCommitItem item in commitItems)
{
m_log.Debug("[SVNBACKUP]: Updated " + item.Path.ToString() + " (" + item.Kind.ToString() + ") " + item.Revision.ToString());
m_log.Debug("[SVNBACKUP]: " + item.Url.ToString() + " -> " + item.CopyFromUrl.ToString());
}
}
m_log.Debug("[SVNBACKUP]: Appending log message.");
logMessage = new AprString("Automated Region Backup", pool);
tmpFile = new SvnPath(pool);
return (SvnError.NoError);
}
#endregion
#region IRegionModule Members
public void Initialise(Scene scene, IConfigSource source)
{
lock (m_scenes)
{
m_scenes.Add(scene);
}
scene.EventManager.OnPluginConsole += EventManager_OnPluginConsole;
}
void EventManager_OnPluginConsole(string[] args)
{
if (args[0] == "testsvn")
SaveRegion(m_scenes[0]);
}
public void PostInitialise()
{
m_log.Info("[SVNBACKUP]: Disabled.");
return;
m_log.Info("[SVNBACKUP]: Connecting...");
m_svnClient = new SvnClient();
m_svnClient.AddUsernameProvider();
m_svnClient.AddPromptProvider(new SvnAuthProviderObject.SimplePrompt(SimpleAuth), IntPtr.Zero, 2);
m_svnClient.OpenAuth();
m_log.Info("[SVNBACKUP]: Checking out base directory...");
if (!System.IO.Directory.Exists(m_svndir))
System.IO.Directory.CreateDirectory(m_svndir);
m_svnClient.Checkout2(m_svnurl, m_svndir, Svn.Revision.Head, Svn.Revision.Head, true, false);
if (m_scenes.Count > 0)
m_serialiser = m_scenes[0].RequestModuleInterface<IRegionSerialiser>();
if (m_installBackupOnLoad)
{
}
}
public void Close()
{
}
public string Name
{
get { return "SvnBackupModule"; }
}
public bool IsSharedModule
{
get { return true; }
}
#endregion
}
}

View File

@ -928,6 +928,36 @@
</Files> </Files>
</Project> </Project>
<Project name="OpenSim.Region.Modules.SvnSerialiser" path="OpenSim/Region/Modules/SvnSerialiser" type="Library">
<Configuration name="Debug">
<Options>
<OutputPath>../../../../bin/</OutputPath>
</Options>
</Configuration>
<Configuration name="Release">
<Options>
<OutputPath>../../../../bin/</OutputPath>
</Options>
</Configuration>
<ReferencePath>../../../../bin/</ReferencePath>
<Reference name="System" localCopy="false"/>
<Reference name="System.Xml"/>
<Reference name="System.Data"/>
<Reference name="libsecondlife.dll"/>
<Reference name="OpenSim.Framework"/>
<Reference name="OpenSim.Framework.Communications"/>
<Reference name="OpenSim.Data.Base" />
<Reference name="OpenSim.Region.Environment"/>
<Reference name="Nini.dll" />
<Reference name="PumaCode.SvnDotNet.dll" />
<Reference name="log4net"/>
<Files>
<Match pattern="*.cs" recurse="true"/>
</Files>
</Project>
<Project name="OpenSim.DataStore.MSSQL" path="OpenSim/Region/Storage/OpenSim.DataStore.MSSQL" type="Library"> <Project name="OpenSim.DataStore.MSSQL" path="OpenSim/Region/Storage/OpenSim.DataStore.MSSQL" type="Library">
<Configuration name="Debug"> <Configuration name="Debug">
<Options> <Options>