Split up the fetcher code into FetcherBase and FetcherGit
This commit is contained in:
parent
c7f5545886
commit
3be31fbcb6
|
@ -8,7 +8,8 @@ SOURCES = \
|
||||||
SparkleBackend.cs \
|
SparkleBackend.cs \
|
||||||
SparkleCommit.cs \
|
SparkleCommit.cs \
|
||||||
SparkleEvents.cs \
|
SparkleEvents.cs \
|
||||||
SparkleFetcher.cs \
|
SparkleFetcherBase.cs \
|
||||||
|
SparkleFetcherGit.cs \
|
||||||
SparkleGit.cs \
|
SparkleGit.cs \
|
||||||
SparkleHelpers.cs \
|
SparkleHelpers.cs \
|
||||||
SparkleListenerBase.cs \
|
SparkleListenerBase.cs \
|
||||||
|
|
|
@ -1,191 +0,0 @@
|
||||||
// SparkleShare, an instant update workflow to Git.
|
|
||||||
// Copyright (C) 2010 Hylke Bons <hylkebons@gmail.com>
|
|
||||||
//
|
|
||||||
// This program 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 3 of the License, or
|
|
||||||
// (at your option) any later version.
|
|
||||||
//
|
|
||||||
// This program 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, see <http://www.gnu.org/licenses/>.
|
|
||||||
|
|
||||||
|
|
||||||
using System;
|
|
||||||
using System.IO;
|
|
||||||
using System.Diagnostics;
|
|
||||||
using System.Threading;
|
|
||||||
using System.Xml; // TODO: move to subclass later
|
|
||||||
|
|
||||||
namespace SparkleLib {
|
|
||||||
|
|
||||||
// Sets up a fetcher that can get remote folders
|
|
||||||
public class SparkleFetcher {
|
|
||||||
|
|
||||||
public delegate void StartedEventHandler (object o, SparkleEventArgs args);
|
|
||||||
public delegate void FinishedEventHandler (object o, SparkleEventArgs args);
|
|
||||||
public delegate void FailedEventHandler (object o, SparkleEventArgs args);
|
|
||||||
|
|
||||||
public event StartedEventHandler Started;
|
|
||||||
public event FinishedEventHandler Finished;
|
|
||||||
public event FailedEventHandler Failed;
|
|
||||||
|
|
||||||
private string target_folder;
|
|
||||||
private string remote_url;
|
|
||||||
private Thread thread;
|
|
||||||
|
|
||||||
|
|
||||||
public SparkleFetcher (string remote_url, string target_folder)
|
|
||||||
{
|
|
||||||
this.target_folder = target_folder;
|
|
||||||
this.remote_url = remote_url;
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
// Clones the remote repository
|
|
||||||
public void Start ()
|
|
||||||
{
|
|
||||||
SparkleHelpers.DebugInfo ("Fetcher", "[" + this.target_folder + "] Fetching folder...");
|
|
||||||
|
|
||||||
if (Started != null)
|
|
||||||
Started (this, new SparkleEventArgs ("Started"));
|
|
||||||
|
|
||||||
if (Directory.Exists (this.target_folder))
|
|
||||||
Directory.Delete (this.target_folder, true);
|
|
||||||
|
|
||||||
this.thread = new Thread (new ThreadStart (delegate {
|
|
||||||
if (Fetch ()) {
|
|
||||||
SparkleHelpers.DebugInfo ("Fetcher", "[" + this.target_folder + "] Fetching finished");
|
|
||||||
|
|
||||||
if (Finished != null)
|
|
||||||
Finished (this, new SparkleEventArgs ("Finished"));
|
|
||||||
} else {
|
|
||||||
SparkleHelpers.DebugInfo ("Fetcher", "[" + this.target_folder + "] Fetching failed");
|
|
||||||
|
|
||||||
if (Failed != null)
|
|
||||||
Failed (this, new SparkleEventArgs ("Failed"));
|
|
||||||
}
|
|
||||||
}));
|
|
||||||
|
|
||||||
this.thread.Start ();
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
public void Dispose ()
|
|
||||||
{
|
|
||||||
this.thread.Abort ();
|
|
||||||
this.thread.Join ();
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
// TODO: abstract -> override
|
|
||||||
public virtual bool Fetch ()
|
|
||||||
{
|
|
||||||
SparkleGit git = new SparkleGit (SparklePaths.SparkleTmpPath,
|
|
||||||
"clone \"" + this.remote_url + "\" " + "\"" + this.target_folder + "\"");
|
|
||||||
|
|
||||||
git.Start ();
|
|
||||||
git.WaitForExit ();
|
|
||||||
|
|
||||||
SparkleHelpers.DebugInfo ("Git", "Exit code " + git.ExitCode.ToString ());
|
|
||||||
|
|
||||||
if (git.ExitCode != 0) {
|
|
||||||
return false;
|
|
||||||
} else {
|
|
||||||
InstallConfiguration ();
|
|
||||||
InstallExcludeRules ();
|
|
||||||
return true;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
// Install the user's name and email and some config into
|
|
||||||
// the newly cloned repository
|
|
||||||
private void InstallConfiguration ()
|
|
||||||
{
|
|
||||||
string global_config_file_path = Path.Combine (SparklePaths.SparkleConfigPath, "config.xml");
|
|
||||||
|
|
||||||
if (File.Exists (global_config_file_path)) {
|
|
||||||
string repo_config_file_path = SparkleHelpers.CombineMore (this.target_folder, ".git", "config");
|
|
||||||
string config = String.Join (Environment.NewLine, File.ReadAllLines (repo_config_file_path));
|
|
||||||
|
|
||||||
// Be case sensitive explicitly to work on Mac
|
|
||||||
config = config.Replace ("ignorecase = true", "ignorecase = false");
|
|
||||||
|
|
||||||
// Ignore permission changes
|
|
||||||
config = config.Replace ("filemode = true", "filemode = false");
|
|
||||||
|
|
||||||
// Add user info
|
|
||||||
string n = Environment.NewLine;
|
|
||||||
XmlDocument xml = new XmlDocument();
|
|
||||||
xml.Load (global_config_file_path);
|
|
||||||
|
|
||||||
XmlNode node_name = xml.SelectSingleNode ("//user/name/text()");
|
|
||||||
XmlNode node_email = xml.SelectSingleNode ("//user/email/text()");
|
|
||||||
|
|
||||||
config += n +
|
|
||||||
"[user]" + n +
|
|
||||||
"\tname = " + node_name.Value + n +
|
|
||||||
"\temail = " + node_email.Value + n;
|
|
||||||
|
|
||||||
// Write the config to the file
|
|
||||||
TextWriter writer = new StreamWriter (repo_config_file_path);
|
|
||||||
writer.WriteLine (config);
|
|
||||||
writer.Close ();
|
|
||||||
|
|
||||||
SparkleHelpers.DebugInfo ("Config", "Added configuration to '" + repo_config_file_path + "'");
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
// Add a .gitignore file to the repo
|
|
||||||
private void InstallExcludeRules ()
|
|
||||||
{
|
|
||||||
string exlude_rules_file_path = SparkleHelpers.CombineMore (
|
|
||||||
this.target_folder, ".git", "info", "exclude");
|
|
||||||
|
|
||||||
TextWriter writer = new StreamWriter (exlude_rules_file_path);
|
|
||||||
|
|
||||||
// gedit and emacs
|
|
||||||
writer.WriteLine ("*~");
|
|
||||||
|
|
||||||
// vi(m)
|
|
||||||
writer.WriteLine (".*.sw[a-z]");
|
|
||||||
writer.WriteLine ("*.un~");
|
|
||||||
writer.WriteLine ("*.swp");
|
|
||||||
writer.WriteLine ("*.swo");
|
|
||||||
|
|
||||||
// KDE
|
|
||||||
writer.WriteLine (".directory");
|
|
||||||
|
|
||||||
// Mac OSX
|
|
||||||
writer.WriteLine (".DS_Store");
|
|
||||||
writer.WriteLine ("Icon?");
|
|
||||||
writer.WriteLine ("._*");
|
|
||||||
writer.WriteLine (".Spotlight-V100");
|
|
||||||
writer.WriteLine (".Trashes");
|
|
||||||
|
|
||||||
// Mac OSX
|
|
||||||
writer.WriteLine ("*(Autosaved).graffle");
|
|
||||||
|
|
||||||
// Windows
|
|
||||||
writer.WriteLine ("Thumbs.db");
|
|
||||||
writer.WriteLine ("Desktop.ini");
|
|
||||||
|
|
||||||
// CVS
|
|
||||||
writer.WriteLine ("*/CVS/*");
|
|
||||||
writer.WriteLine (".cvsignore");
|
|
||||||
writer.WriteLine ("*/.cvsignore");
|
|
||||||
|
|
||||||
// Subversion
|
|
||||||
writer.WriteLine ("/.svn/*");
|
|
||||||
writer.WriteLine ("*/.svn/*");
|
|
||||||
|
|
||||||
writer.Close ();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
86
SparkleLib/SparkleFetcherBase.cs
Normal file
86
SparkleLib/SparkleFetcherBase.cs
Normal file
|
@ -0,0 +1,86 @@
|
||||||
|
// SparkleShare, an instant update workflow to Git.
|
||||||
|
// Copyright (C) 2010 Hylke Bons <hylkebons@gmail.com>
|
||||||
|
//
|
||||||
|
// This program 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 3 of the License, or
|
||||||
|
// (at your option) any later version.
|
||||||
|
//
|
||||||
|
// This program 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, see <http://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
|
||||||
|
using System;
|
||||||
|
using System.IO;
|
||||||
|
using System.Diagnostics;
|
||||||
|
using System.Threading;
|
||||||
|
|
||||||
|
namespace SparkleLib {
|
||||||
|
|
||||||
|
// Sets up a fetcher that can get remote folders
|
||||||
|
public abstract class SparkleFetcherBase {
|
||||||
|
|
||||||
|
public delegate void StartedEventHandler (object o, SparkleEventArgs args);
|
||||||
|
public delegate void FinishedEventHandler (object o, SparkleEventArgs args);
|
||||||
|
public delegate void FailedEventHandler (object o, SparkleEventArgs args);
|
||||||
|
|
||||||
|
public event StartedEventHandler Started;
|
||||||
|
public event FinishedEventHandler Finished;
|
||||||
|
public event FailedEventHandler Failed;
|
||||||
|
|
||||||
|
protected string target_folder;
|
||||||
|
protected string remote_url;
|
||||||
|
private Thread thread;
|
||||||
|
|
||||||
|
|
||||||
|
public SparkleFetcherBase (string remote_url, string target_folder)
|
||||||
|
{
|
||||||
|
this.target_folder = target_folder;
|
||||||
|
this.remote_url = remote_url;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
// Clones the remote repository
|
||||||
|
public void Start ()
|
||||||
|
{
|
||||||
|
SparkleHelpers.DebugInfo ("Fetcher", "[" + this.target_folder + "] Fetching folder...");
|
||||||
|
|
||||||
|
if (Started != null)
|
||||||
|
Started (this, new SparkleEventArgs ("Started"));
|
||||||
|
|
||||||
|
if (Directory.Exists (this.target_folder))
|
||||||
|
Directory.Delete (this.target_folder, true);
|
||||||
|
|
||||||
|
this.thread = new Thread (new ThreadStart (delegate {
|
||||||
|
if (Fetch ()) {
|
||||||
|
SparkleHelpers.DebugInfo ("Fetcher", "[" + this.target_folder + "] Fetching finished");
|
||||||
|
|
||||||
|
if (Finished != null)
|
||||||
|
Finished (this, new SparkleEventArgs ("Finished"));
|
||||||
|
} else {
|
||||||
|
SparkleHelpers.DebugInfo ("Fetcher", "[" + this.target_folder + "] Fetching failed");
|
||||||
|
|
||||||
|
if (Failed != null)
|
||||||
|
Failed (this, new SparkleEventArgs ("Failed"));
|
||||||
|
}
|
||||||
|
}));
|
||||||
|
|
||||||
|
this.thread.Start ();
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
public void Dispose ()
|
||||||
|
{
|
||||||
|
this.thread.Abort ();
|
||||||
|
this.thread.Join ();
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
public abstract bool Fetch ();
|
||||||
|
}
|
||||||
|
}
|
139
SparkleLib/SparkleFetcherGit.cs
Normal file
139
SparkleLib/SparkleFetcherGit.cs
Normal file
|
@ -0,0 +1,139 @@
|
||||||
|
// SparkleShare, an instant update workflow to Git.
|
||||||
|
// Copyright (C) 2010 Hylke Bons <hylkebons@gmail.com>
|
||||||
|
//
|
||||||
|
// This program 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 3 of the License, or
|
||||||
|
// (at your option) any later version.
|
||||||
|
//
|
||||||
|
// This program 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, see <http://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
|
||||||
|
using System;
|
||||||
|
using System.IO;
|
||||||
|
using System.Diagnostics;
|
||||||
|
using System.Xml; // TODO: move to subclass later
|
||||||
|
|
||||||
|
namespace SparkleLib {
|
||||||
|
|
||||||
|
// Sets up a fetcher that can get remote folders
|
||||||
|
public class SparkleFetcherGit : SparkleFetcherBase {
|
||||||
|
|
||||||
|
public SparkleFetcherGit (string remote_url, string target_folder) :
|
||||||
|
base (remote_url, target_folder) { }
|
||||||
|
|
||||||
|
|
||||||
|
public override bool Fetch ()
|
||||||
|
{
|
||||||
|
SparkleGit git = new SparkleGit (SparklePaths.SparkleTmpPath,
|
||||||
|
"clone \"" + base.remote_url + "\" " + "\"" + base.target_folder + "\"");
|
||||||
|
|
||||||
|
git.Start ();
|
||||||
|
git.WaitForExit ();
|
||||||
|
|
||||||
|
SparkleHelpers.DebugInfo ("Git", "Exit code " + git.ExitCode.ToString ());
|
||||||
|
|
||||||
|
if (git.ExitCode != 0) {
|
||||||
|
return false;
|
||||||
|
} else {
|
||||||
|
InstallConfiguration ();
|
||||||
|
InstallExcludeRules ();
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
// Install the user's name and email and some config into
|
||||||
|
// the newly cloned repository
|
||||||
|
private void InstallConfiguration ()
|
||||||
|
{
|
||||||
|
string global_config_file_path = Path.Combine (SparklePaths.SparkleConfigPath, "config.xml");
|
||||||
|
|
||||||
|
if (!File.Exists (global_config_file_path))
|
||||||
|
return;
|
||||||
|
|
||||||
|
string repo_config_file_path = SparkleHelpers.CombineMore (base.target_folder, ".git", "config");
|
||||||
|
string config = String.Join (Environment.NewLine, File.ReadAllLines (repo_config_file_path));
|
||||||
|
|
||||||
|
// Be case sensitive explicitly to work on Mac
|
||||||
|
config = config.Replace ("ignorecase = true", "ignorecase = false");
|
||||||
|
|
||||||
|
// Ignore permission changes
|
||||||
|
config = config.Replace ("filemode = true", "filemode = false");
|
||||||
|
|
||||||
|
// Add user info
|
||||||
|
string n = Environment.NewLine;
|
||||||
|
XmlDocument xml = new XmlDocument();
|
||||||
|
xml.Load (global_config_file_path);
|
||||||
|
|
||||||
|
XmlNode node_name = xml.SelectSingleNode ("//user/name/text()");
|
||||||
|
XmlNode node_email = xml.SelectSingleNode ("//user/email/text()");
|
||||||
|
|
||||||
|
// TODO: just use commands instead of messing with the config file
|
||||||
|
config += n +
|
||||||
|
"[user]" + n +
|
||||||
|
"\tname = " + node_name.Value + n +
|
||||||
|
"\temail = " + node_email.Value + n;
|
||||||
|
|
||||||
|
// Write the config to the file
|
||||||
|
TextWriter writer = new StreamWriter (repo_config_file_path);
|
||||||
|
writer.WriteLine (config);
|
||||||
|
writer.Close ();
|
||||||
|
|
||||||
|
SparkleHelpers.DebugInfo ("Config", "Added configuration to '" + repo_config_file_path + "'");
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
// Add a .gitignore file to the repo
|
||||||
|
private void InstallExcludeRules ()
|
||||||
|
{
|
||||||
|
string exlude_rules_file_path = SparkleHelpers.CombineMore (
|
||||||
|
this.target_folder, ".git", "info", "exclude");
|
||||||
|
|
||||||
|
TextWriter writer = new StreamWriter (exlude_rules_file_path);
|
||||||
|
|
||||||
|
// gedit and emacs
|
||||||
|
writer.WriteLine ("*~");
|
||||||
|
|
||||||
|
// vi(m)
|
||||||
|
writer.WriteLine (".*.sw[a-z]");
|
||||||
|
writer.WriteLine ("*.un~");
|
||||||
|
writer.WriteLine ("*.swp");
|
||||||
|
writer.WriteLine ("*.swo");
|
||||||
|
|
||||||
|
// KDE
|
||||||
|
writer.WriteLine (".directory");
|
||||||
|
|
||||||
|
// Mac OSX
|
||||||
|
writer.WriteLine (".DS_Store");
|
||||||
|
writer.WriteLine ("Icon?");
|
||||||
|
writer.WriteLine ("._*");
|
||||||
|
writer.WriteLine (".Spotlight-V100");
|
||||||
|
writer.WriteLine (".Trashes");
|
||||||
|
|
||||||
|
// Mac OSX
|
||||||
|
writer.WriteLine ("*(Autosaved).graffle");
|
||||||
|
|
||||||
|
// Windows
|
||||||
|
writer.WriteLine ("Thumbs.db");
|
||||||
|
writer.WriteLine ("Desktop.ini");
|
||||||
|
|
||||||
|
// CVS
|
||||||
|
writer.WriteLine ("*/CVS/*");
|
||||||
|
writer.WriteLine (".cvsignore");
|
||||||
|
writer.WriteLine ("*/.cvsignore");
|
||||||
|
|
||||||
|
// Subversion
|
||||||
|
writer.WriteLine ("/.svn/*");
|
||||||
|
writer.WriteLine ("*/.svn/*");
|
||||||
|
|
||||||
|
writer.Close ();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
|
@ -38,7 +38,8 @@
|
||||||
</ItemGroup>
|
</ItemGroup>
|
||||||
<ItemGroup>
|
<ItemGroup>
|
||||||
<Compile Include="SparkleRepo.cs" />
|
<Compile Include="SparkleRepo.cs" />
|
||||||
<Compile Include="SparkleFetcher.cs" />
|
<Compile Include="SparkleFetcherBase.cs" />
|
||||||
|
<Compile Include="SparkleFetcherGit.cs" />
|
||||||
<Compile Include="Defines.cs" />
|
<Compile Include="Defines.cs" />
|
||||||
<Compile Include="SparkleHelpers.cs" />
|
<Compile Include="SparkleHelpers.cs" />
|
||||||
<Compile Include="SparklePaths.cs" />
|
<Compile Include="SparklePaths.cs" />
|
||||||
|
|
|
@ -324,7 +324,7 @@ namespace SparkleLib {
|
||||||
|
|
||||||
SparkleHelpers.DebugInfo ("Local", "[" + Name + "] Changes have settled.");
|
SparkleHelpers.DebugInfo ("Local", "[" + Name + "] Changes have settled.");
|
||||||
this.is_buffering = false;
|
this.is_buffering = false;
|
||||||
this.has_changed = false;
|
this.has_changed = false;
|
||||||
|
|
||||||
while (AnyDifferences) {
|
while (AnyDifferences) {
|
||||||
this.watcher.EnableRaisingEvents = false;
|
this.watcher.EnableRaisingEvents = false;
|
||||||
|
@ -770,6 +770,7 @@ namespace SparkleLib {
|
||||||
|
|
||||||
|
|
||||||
// Gets the domain name of a given URL
|
// Gets the domain name of a given URL
|
||||||
|
// TODO: make this a regex
|
||||||
private string GetDomain (string url)
|
private string GetDomain (string url)
|
||||||
{
|
{
|
||||||
if (url.Equals (""))
|
if (url.Equals (""))
|
||||||
|
|
|
@ -1001,8 +1001,10 @@ namespace SparkleShare {
|
||||||
// Strip the '.git' from the name
|
// Strip the '.git' from the name
|
||||||
string canonical_name = Path.GetFileNameWithoutExtension (name);
|
string canonical_name = Path.GetFileNameWithoutExtension (name);
|
||||||
string tmp_folder = Path.Combine (SparklePaths.SparkleTmpPath, canonical_name);
|
string tmp_folder = Path.Combine (SparklePaths.SparkleTmpPath, canonical_name);
|
||||||
SparkleFetcher fetcher = new SparkleFetcher (url, tmp_folder);
|
|
||||||
bool folder_exists = Directory.Exists (Path.Combine (SparklePaths.SparklePath, canonical_name));
|
// TODO: backend detection
|
||||||
|
SparkleFetcherBase fetcher = new SparkleFetcherGit (url, tmp_folder);
|
||||||
|
bool folder_exists = Directory.Exists (Path.Combine (SparklePaths.SparklePath, canonical_name));
|
||||||
|
|
||||||
// Add a numbered suffix to the nameif a folder with the same name
|
// Add a numbered suffix to the nameif a folder with the same name
|
||||||
// already exists. Example: "Folder (2)"
|
// already exists. Example: "Folder (2)"
|
||||||
|
|
Loading…
Reference in a new issue