575 lines
19 KiB
C#
Executable file
575 lines
19 KiB
C#
Executable file
// SparkleShare, a collaboration and sharing tool.
|
|
// 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.Collections.Generic;
|
|
using System.IO;
|
|
using System.Security.Cryptography;
|
|
using System.Text;
|
|
using System.Text.RegularExpressions;
|
|
using System.Threading;
|
|
using System.Timers;
|
|
|
|
namespace SparkleLib {
|
|
|
|
public enum SyncStatus {
|
|
Idle,
|
|
SyncUp,
|
|
SyncDown,
|
|
Error
|
|
}
|
|
|
|
|
|
public abstract class SparkleRepoBase {
|
|
|
|
private TimeSpan short_interval = new TimeSpan (0, 0, 3, 0);
|
|
private TimeSpan long_interval = new TimeSpan (0, 0, 10, 0);
|
|
private TimeSpan poll_interval;
|
|
private SparkleWatcher watcher;
|
|
private SparkleListenerBase listener;
|
|
private System.Timers.Timer local_timer = new System.Timers.Timer () { Interval = 0.25 * 1000 };
|
|
private System.Timers.Timer remote_timer = new System.Timers.Timer () { Interval = 10 * 1000 };
|
|
private DateTime last_poll = DateTime.Now;
|
|
private List<double> size_buffer = new List<double> ();
|
|
private Object change_lock = new Object ();
|
|
private Object watch_lock = new Object ();
|
|
private double progress_percentage = 0.0;
|
|
private string progress_speed = "";
|
|
private bool has_changed = false;
|
|
private bool is_buffering = false;
|
|
private bool server_online = true;
|
|
private SyncStatus status;
|
|
|
|
|
|
public delegate void SyncStatusChangedEventHandler (SyncStatus new_status);
|
|
public event SyncStatusChangedEventHandler SyncStatusChanged;
|
|
|
|
public delegate void ProgressChangedEventHandler (double percentage, string speed);
|
|
public event ProgressChangedEventHandler ProgressChanged;
|
|
|
|
public delegate void NewChangeSetEventHandler (SparkleChangeSet change_set);
|
|
public event NewChangeSetEventHandler NewChangeSet;
|
|
|
|
public delegate void ConflictResolvedEventHandler ();
|
|
public event ConflictResolvedEventHandler ConflictResolved;
|
|
|
|
public delegate void ChangesDetectedEventHandler ();
|
|
public event ChangesDetectedEventHandler ChangesDetected;
|
|
|
|
|
|
public readonly string LocalPath;
|
|
public readonly string Name;
|
|
public readonly Uri Url;
|
|
|
|
public abstract string Identifier { get; }
|
|
public abstract string CurrentRevision { get; }
|
|
public abstract double Size { get; }
|
|
public abstract double HistorySize { get; }
|
|
public abstract List<string> ExcludePaths { get; }
|
|
public abstract bool HasUnsyncedChanges { get; set; }
|
|
public abstract bool HasLocalChanges { get; }
|
|
public abstract bool HasRemoteChanges { get; }
|
|
public abstract bool SyncUp ();
|
|
public abstract bool SyncDown ();
|
|
public abstract List<SparkleChangeSet> GetChangeSets (int count);
|
|
|
|
|
|
public bool ServerOnline {
|
|
get {
|
|
return this.server_online;
|
|
}
|
|
}
|
|
|
|
public SyncStatus Status {
|
|
get {
|
|
return this.status;
|
|
}
|
|
}
|
|
|
|
public double ProgressPercentage {
|
|
get {
|
|
return this.progress_percentage;
|
|
}
|
|
}
|
|
|
|
public string ProgressSpeed {
|
|
get {
|
|
return this.progress_speed;
|
|
}
|
|
}
|
|
|
|
public virtual string [] UnsyncedFilePaths {
|
|
get {
|
|
return new string [0];
|
|
}
|
|
}
|
|
|
|
public bool IsSyncing {
|
|
get {
|
|
return (Status == SyncStatus.SyncUp ||
|
|
Status == SyncStatus.SyncDown ||
|
|
this.is_buffering);
|
|
}
|
|
}
|
|
|
|
public bool IsBuffering {
|
|
get {
|
|
return this.is_buffering;
|
|
}
|
|
}
|
|
|
|
|
|
public SparkleRepoBase (string path)
|
|
{
|
|
LocalPath = path;
|
|
Name = Path.GetFileName (LocalPath);
|
|
Url = new Uri (SparkleConfig.DefaultConfig.GetUrlForFolder (Name));
|
|
|
|
this.poll_interval = this.short_interval;
|
|
|
|
SyncStatusChanged += delegate (SyncStatus status) {
|
|
this.status = status;
|
|
};
|
|
|
|
if (CurrentRevision == null)
|
|
CreateInitialChangeSet ();
|
|
|
|
CreateWatcher ();
|
|
CreateListener ();
|
|
|
|
this.local_timer.Elapsed += delegate (object o, ElapsedEventArgs args) {
|
|
CheckForChanges ();
|
|
};
|
|
|
|
this.remote_timer.Elapsed += delegate {
|
|
bool time_to_poll = (DateTime.Compare (this.last_poll,
|
|
DateTime.Now.Subtract (this.poll_interval)) < 0);
|
|
|
|
if (time_to_poll) {
|
|
this.last_poll = DateTime.Now;
|
|
|
|
if (HasRemoteChanges)
|
|
SyncDownBase ();
|
|
}
|
|
|
|
// In the unlikely case that we haven't synced up our
|
|
// changes or the server was down, sync up again
|
|
if (HasUnsyncedChanges && !IsSyncing && this.server_online)
|
|
SyncUpBase ();
|
|
};
|
|
|
|
|
|
}
|
|
|
|
|
|
public void Initialize ()
|
|
{
|
|
// Sync up everything that changed
|
|
// since we've been offline
|
|
if (HasLocalChanges) {
|
|
DisableWatching ();
|
|
SyncUpBase ();
|
|
|
|
while (HasUnsyncedChanges)
|
|
SyncUpBase ();
|
|
|
|
EnableWatching ();
|
|
}
|
|
|
|
this.remote_timer.Start ();
|
|
this.local_timer.Start ();
|
|
}
|
|
|
|
|
|
protected void OnConflictResolved ()
|
|
{
|
|
HasUnsyncedChanges = true; // ?
|
|
|
|
if (ConflictResolved != null)
|
|
ConflictResolved ();
|
|
}
|
|
|
|
|
|
// Disposes all resourses of this object
|
|
public void Dispose ()
|
|
{
|
|
this.remote_timer.Dispose ();
|
|
this.local_timer.Dispose ();
|
|
this.listener.Dispose ();
|
|
}
|
|
|
|
|
|
// Starts a timer when something changes
|
|
public void OnFileActivity (FileSystemEventArgs args)
|
|
{
|
|
// Check the watcher for the occasions where this
|
|
// method is called directly
|
|
if (!this.watcher.EnableRaisingEvents)
|
|
return;
|
|
|
|
string relative_path = args.FullPath.Replace (LocalPath, "");
|
|
|
|
foreach (string exclude_path in ExcludePaths) {
|
|
if (relative_path.Contains (exclude_path))
|
|
return;
|
|
}
|
|
|
|
WatcherChangeTypes wct = args.ChangeType;
|
|
|
|
if (HasLocalChanges) {
|
|
this.is_buffering = true;
|
|
|
|
// We want to disable wathcing temporarily, but
|
|
// not stop the local timer
|
|
this.watcher.EnableRaisingEvents = false;
|
|
|
|
// Only fire the event if the timer has been stopped.
|
|
// This prevents multiple events from being raised whilst "buffering".
|
|
if (!this.has_changed) {
|
|
if (ChangesDetected != null)
|
|
ChangesDetected ();
|
|
}
|
|
|
|
SparkleHelpers.DebugInfo ("Event", "[" + Name + "] " + wct.ToString () + " '" + args.Name + "'");
|
|
SparkleHelpers.DebugInfo ("Event", "[" + Name + "] Changes found, checking if settled.");
|
|
|
|
this.remote_timer.Stop ();
|
|
|
|
lock (this.change_lock) {
|
|
this.has_changed = true;
|
|
}
|
|
}
|
|
}
|
|
|
|
|
|
private void SyncUpBase ()
|
|
{
|
|
try {
|
|
DisableWatching ();
|
|
this.remote_timer.Stop ();
|
|
|
|
SparkleHelpers.DebugInfo ("SyncUp", "[" + Name + "] Initiated");
|
|
|
|
if (SyncStatusChanged != null)
|
|
SyncStatusChanged (SyncStatus.SyncUp);
|
|
|
|
if (SyncUp ()) {
|
|
SparkleHelpers.DebugInfo ("SyncUp", "[" + Name + "] Done");
|
|
|
|
HasUnsyncedChanges = false;
|
|
|
|
if (SyncStatusChanged != null)
|
|
SyncStatusChanged (SyncStatus.Idle);
|
|
|
|
this.listener.Announce (new SparkleAnnouncement (Identifier, CurrentRevision));
|
|
|
|
} else {
|
|
SparkleHelpers.DebugInfo ("SyncUp", "[" + Name + "] Error");
|
|
|
|
HasUnsyncedChanges = true;
|
|
SyncDownBase ();
|
|
DisableWatching ();
|
|
|
|
if (this.server_online && SyncUp ()) {
|
|
HasUnsyncedChanges = false;
|
|
|
|
if (SyncStatusChanged != null)
|
|
SyncStatusChanged (SyncStatus.Idle);
|
|
|
|
this.listener.Announce (new SparkleAnnouncement (Identifier, CurrentRevision));
|
|
|
|
} else {
|
|
this.server_online = false;
|
|
|
|
if (SyncStatusChanged != null)
|
|
SyncStatusChanged (SyncStatus.Error);
|
|
}
|
|
}
|
|
|
|
} finally {
|
|
this.remote_timer.Start ();
|
|
EnableWatching ();
|
|
|
|
this.progress_percentage = 0.0;
|
|
this.progress_speed = "";
|
|
}
|
|
}
|
|
|
|
|
|
private void SyncDownBase ()
|
|
{
|
|
SparkleHelpers.DebugInfo ("SyncDown", "[" + Name + "] Initiated");
|
|
this.remote_timer.Stop ();
|
|
DisableWatching ();
|
|
|
|
if (SyncStatusChanged != null)
|
|
SyncStatusChanged (SyncStatus.SyncDown);
|
|
|
|
string pre_sync_revision = CurrentRevision;
|
|
|
|
if (SyncDown ()) {
|
|
SparkleHelpers.DebugInfo ("SyncDown", "[" + Name + "] Done");
|
|
this.server_online = true;
|
|
|
|
if (!pre_sync_revision.Equals (CurrentRevision)) {
|
|
List<SparkleChangeSet> change_sets = GetChangeSets (1);
|
|
|
|
if (change_sets != null && change_sets.Count > 0) {
|
|
if (NewChangeSet != null)
|
|
NewChangeSet (change_sets [0]);
|
|
}
|
|
}
|
|
|
|
// There could be changes from a resolved
|
|
// conflict. Tries only once, then lets
|
|
// the timer try again periodically
|
|
if (HasUnsyncedChanges) {
|
|
if (SyncStatusChanged != null)
|
|
SyncStatusChanged (SyncStatus.SyncUp);
|
|
|
|
SyncUp ();
|
|
HasUnsyncedChanges = false;
|
|
}
|
|
|
|
if (SyncStatusChanged != null)
|
|
SyncStatusChanged (SyncStatus.Idle);
|
|
|
|
} else {
|
|
SparkleHelpers.DebugInfo ("SyncDown", "[" + Name + "] Error");
|
|
this.server_online = false;
|
|
|
|
if (SyncStatusChanged != null)
|
|
SyncStatusChanged (SyncStatus.Error);
|
|
}
|
|
|
|
if (SyncStatusChanged != null)
|
|
SyncStatusChanged (SyncStatus.Idle);
|
|
|
|
this.remote_timer.Start ();
|
|
EnableWatching ();
|
|
|
|
this.progress_percentage = 0.0;
|
|
this.progress_speed = "";
|
|
}
|
|
|
|
|
|
private void CreateWatcher ()
|
|
{
|
|
this.watcher = new SparkleWatcher (LocalPath);
|
|
this.watcher.ChangeEvent += delegate (FileSystemEventArgs args) {
|
|
OnFileActivity (args);
|
|
};
|
|
}
|
|
|
|
|
|
private void CreateListener ()
|
|
{
|
|
this.listener = SparkleListenerFactory.CreateListener (Name, Identifier);
|
|
|
|
if (this.listener.IsConnected) {
|
|
this.poll_interval = this.long_interval;
|
|
|
|
new Thread (new ThreadStart (delegate {
|
|
if (!IsSyncing && HasRemoteChanges)
|
|
SyncDownBase ();
|
|
})).Start ();
|
|
}
|
|
|
|
// Stop polling when the connection to the irc channel is succesful
|
|
this.listener.Connected += delegate {
|
|
this.poll_interval = this.long_interval;
|
|
this.last_poll = DateTime.Now;
|
|
|
|
if (!IsSyncing) {
|
|
|
|
// Check for changes manually one more time
|
|
if (HasRemoteChanges)
|
|
SyncDownBase ();
|
|
|
|
// Push changes that were made since the last disconnect
|
|
if (HasUnsyncedChanges)
|
|
SyncUpBase ();
|
|
}
|
|
};
|
|
|
|
// Start polling when the connection to the irc channel is lost
|
|
this.listener.Disconnected += delegate {
|
|
this.poll_interval = this.short_interval;
|
|
SparkleHelpers.DebugInfo (Name, "Falling back to polling");
|
|
};
|
|
|
|
// Fetch changes when there is a message in the irc channel
|
|
this.listener.Received += delegate (SparkleAnnouncement announcement) {
|
|
string identifier = Identifier;
|
|
|
|
if (announcement.FolderIdentifier.Equals (identifier) &&
|
|
!announcement.Message.Equals (CurrentRevision)) {
|
|
|
|
while (this.IsSyncing)
|
|
System.Threading.Thread.Sleep (100);
|
|
|
|
SparkleHelpers.DebugInfo ("Listener", "Syncing due to announcement");
|
|
SyncDownBase ();
|
|
|
|
} else {
|
|
if (announcement.FolderIdentifier.Equals (identifier))
|
|
SparkleHelpers.DebugInfo ("Listener", "Not syncing, message is for current revision");
|
|
}
|
|
};
|
|
|
|
// Start listening
|
|
if (!this.listener.IsConnected && !this.listener.IsConnecting)
|
|
this.listener.Connect ();
|
|
}
|
|
|
|
|
|
private void CheckForChanges ()
|
|
{
|
|
lock (this.change_lock) {
|
|
if (this.has_changed) {
|
|
if (this.size_buffer.Count >= 4)
|
|
this.size_buffer.RemoveAt (0);
|
|
|
|
DirectoryInfo dir_info = new DirectoryInfo (LocalPath);
|
|
this.size_buffer.Add (CalculateSize (dir_info));
|
|
|
|
if (this.size_buffer.Count >= 4 &&
|
|
this.size_buffer [0].Equals (this.size_buffer [1]) &&
|
|
this.size_buffer [1].Equals (this.size_buffer [2]) &&
|
|
this.size_buffer [2].Equals (this.size_buffer [3])) {
|
|
|
|
SparkleHelpers.DebugInfo ("Local", "[" + Name + "] Changes have settled.");
|
|
this.is_buffering = false;
|
|
this.has_changed = false;
|
|
|
|
DisableWatching ();
|
|
while (HasLocalChanges)
|
|
SyncUpBase ();
|
|
EnableWatching ();
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
|
|
protected void DisableWatching ()
|
|
{
|
|
lock (this.watch_lock) {
|
|
this.watcher.EnableRaisingEvents = false;
|
|
this.local_timer.Stop ();
|
|
}
|
|
}
|
|
|
|
|
|
protected void EnableWatching ()
|
|
{
|
|
lock (this.watch_lock) {
|
|
this.watcher.EnableRaisingEvents = true;
|
|
this.local_timer.Start ();
|
|
}
|
|
}
|
|
|
|
|
|
private DateTime progress_last_change = DateTime.Now;
|
|
private TimeSpan progress_change_interval = new TimeSpan (0, 0, 0, 1);
|
|
|
|
protected void OnProgressChanged (double progress_percentage, string progress_speed)
|
|
{
|
|
if (DateTime.Compare (this.progress_last_change,
|
|
DateTime.Now.Subtract (this.progress_change_interval)) < 0) {
|
|
|
|
if (ProgressChanged != null) {
|
|
if (progress_percentage == 100.0)
|
|
progress_percentage = 99.0;
|
|
|
|
this.progress_percentage = progress_percentage;
|
|
this.progress_speed = progress_speed;
|
|
this.progress_last_change = DateTime.Now;
|
|
|
|
ProgressChanged (progress_percentage, progress_speed);
|
|
}
|
|
}
|
|
}
|
|
|
|
|
|
// Create an initial change set when the
|
|
// user has fetched an empty remote folder
|
|
private void CreateInitialChangeSet ()
|
|
{
|
|
string file_path = Path.Combine (LocalPath, "SparkleShare.txt");
|
|
TextWriter writer = new StreamWriter (file_path);
|
|
|
|
writer.WriteLine ("Congratulations, you've successfully created a SparkleShare repository!");
|
|
writer.WriteLine ("");
|
|
writer.WriteLine ("Any files you add or change in this folder will be automatically synced to ");
|
|
writer.WriteLine (Url + " and everyone connected to it.");
|
|
|
|
writer.WriteLine ("");
|
|
writer.WriteLine ("SparkleShare is a Free and Open Source software program that helps people ");
|
|
writer.WriteLine ("collaborate and share files. If you like what we do, please consider a small ");
|
|
writer.WriteLine ("donation to support the project: http://sparkleshare.org/support-us/");
|
|
writer.WriteLine ("");
|
|
writer.WriteLine ("Have fun! :)");
|
|
writer.WriteLine ("");
|
|
|
|
writer.Close ();
|
|
|
|
SyncUp ();
|
|
}
|
|
|
|
|
|
// Creates a SHA-1 hash of input
|
|
private string SHA1 (string s)
|
|
{
|
|
SHA1 sha1 = new SHA1CryptoServiceProvider ();
|
|
Byte[] bytes = ASCIIEncoding.Default.GetBytes (s);
|
|
Byte[] encoded_bytes = sha1.ComputeHash (bytes);
|
|
return BitConverter.ToString (encoded_bytes).ToLower ().Replace ("-", "");
|
|
}
|
|
|
|
|
|
// Recursively gets a folder's size in bytes
|
|
private double CalculateSize (DirectoryInfo parent)
|
|
{
|
|
if (!Directory.Exists (parent.ToString ()))
|
|
return 0;
|
|
|
|
double size = 0;
|
|
|
|
if (ExcludePaths.Contains (parent.Name))
|
|
return 0;
|
|
|
|
try {
|
|
foreach (FileInfo file in parent.GetFiles()) {
|
|
if (!file.Exists)
|
|
return 0;
|
|
|
|
size += file.Length;
|
|
}
|
|
|
|
foreach (DirectoryInfo directory in parent.GetDirectories ())
|
|
size += CalculateSize (directory);
|
|
|
|
} catch (Exception) {
|
|
return 0;
|
|
}
|
|
|
|
return size;
|
|
}
|
|
}
|
|
}
|