SparkleShare/SparkleDiff/SparkleDiff.cs

//   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 Gtk;
using Mono.Unix;
using System;
using System.Diagnostics;
using System.IO;
using System.Text.RegularExpressions;

namespace SparkleShare {

	public class SparkleDiff
	{

		// Short alias for the translations
		public static string _ (string s)
		{
			return Catalog.GetString (s);
		}

		public static void Main (string [] args)
		{

			Catalog.Init (Defines.GETTEXT_PACKAGE, Defines.LOCALE_DIR);

			// Check whether git is installed
			Process Process = new Process ();
			Process.StartInfo.FileName = "git";
			Process.StartInfo.RedirectStandardOutput = true;
			Process.StartInfo.UseShellExecute = false;
			Process.Start ();

			if (Process.StandardOutput.ReadToEnd ().IndexOf ("version") == -1) {
				Console.WriteLine (_("Git wasn't found."));
				Console.WriteLine (_("You can get Git from http://git-scm.com/."));
				Environment.Exit (0);
			}

			// Don't allow running as root
			UnixUserInfo UnixUserInfo =	new UnixUserInfo (UnixEnvironment.UserName);
			if (UnixUserInfo.UserId == 0) {
				Console.WriteLine (_("Sorry, you can't run SparkleShare with these permissions."));
				Console.WriteLine (_("Things would go utterly wrong.")); 
				Environment.Exit (0);
			}

			if (args.Length > 0) {
				if (args [0].Equals ("--help") || args [0].Equals ("-h")) {
					ShowHelp ();
					Environment.Exit (0);
				}

				string file_path = args [0];

				if (File.Exists (file_path)) {

					Gtk.Application.Init ();

					SparkleDiffWindow sparkle_diff_window;
					sparkle_diff_window = new SparkleDiffWindow (file_path);
					sparkle_diff_window.ShowAll ();

					// The main loop
					Gtk.Application.Run ();

				} else {

					Console.WriteLine ("SparkleDiff: " + file_path + ": No such file or directory.");
					Environment.Exit (0);

				}
				
			}

		}

		// Prints the help output
		public static void ShowHelp ()
		{
			Console.WriteLine (_("SparkleDiff Copyright (C) 2010 Hylke Bons"));
			Console.WriteLine (" ");
			Console.WriteLine (_("This program comes with ABSOLUTELY NO WARRANTY."));
			Console.WriteLine (_("This is free software, and you are welcome to redistribute it "));
			Console.WriteLine (_("under certain conditions. Please read the GNU GPLv3 for details."));
			Console.WriteLine (" ");
			Console.WriteLine (_("SparkleDiff let's you compare revisions of an image file side by side."));
			Console.WriteLine (" ");
			Console.WriteLine (_("Usage: sparklediff [FILE]"));
			Console.WriteLine (_("Open an image file to show its revisions"));
			Console.WriteLine (" ");
			Console.WriteLine (_("Arguments:"));
			Console.WriteLine (_("\t -h, --help\t\tDisplay this help text."));
			Console.WriteLine (" ");
		}

	}


	public class SparkleDiffWindow : Window
	{

		// Short alias for the translations
		public static string _ (string s)
		{
			return Catalog.GetString (s);
		}

		private RevisionView ViewLeft;
		private RevisionView ViewRight;

		private string [] Revisions;

		public SparkleDiffWindow (string file_path) : base ("")
		{

			string file_name = System.IO.Path.GetFileName (file_path);

			SetSizeRequest (800, 540);
	 		SetPosition (WindowPosition.Center);

			BorderWidth = 12;

			DeleteEvent += Quit;

			IconName = "image-x-generic";

			// TRANSLATORS: The parameter is a filename
			Title = String.Format(_("Comparing Revisions of ‘{0}’"), file_name);
			
			Revisions = GetRevisionsForFilePath (file_path);

			VBox layout_vertical = new VBox (false, 12);

				HBox layout_horizontal = new HBox (false, 12);

					Process process = new Process ();
					process.EnableRaisingEvents = true; 
					process.StartInfo.RedirectStandardOutput = true;
					process.StartInfo.UseShellExecute = false;

					process.StartInfo.WorkingDirectory = System.IO.Path.GetDirectoryName (file_path);
					process.StartInfo.FileName = "git";
					process.StartInfo.Arguments = "log --format=\"%ct\t%an\" " + file_name;
					process.Start ();

					string output = process.StandardOutput.ReadToEnd ();
					string [] revisions_info = Regex.Split (output.Trim (), "\n");

					int i = 0;
					foreach (string revision_info in revisions_info) {

						string [] parts = Regex.Split (revision_info.Trim (), "\t");

						int timestamp = int.Parse (parts [0]);
						string author = parts [1];

						if (i == 0)
							revisions_info [i] = _("Current Revision") + "\t" + author;
						else

							// TRANSLATORS: This is a format specifier according to System.Globalization.DateTimeFormatInfo
							revisions_info [i] = UnixTimestampToDateTime (timestamp).ToString (_("d MMM\tH:mm")) +
							"\t" + author;

						i++;

					}

					ViewLeft  = new LeftRevisionView  (revisions_info);
					ViewRight = new RightRevisionView (revisions_info);

					ViewLeft.SetImage  (new RevisionImage (file_path, Revisions [1]));
					ViewRight.SetImage (new RevisionImage (file_path, Revisions [0]));
					
					ViewLeft.ComboBox.Changed += delegate {

						RevisionImage revision_image;
						revision_image = new RevisionImage (file_path, Revisions [ViewLeft.ComboBox.Active]);
						ViewLeft.SetImage (revision_image);

						HookUpViews ();
						
						ViewLeft.ScrolledWindow.Hadjustment = ViewRight.ScrolledWindow.Hadjustment;
						ViewLeft.ScrolledWindow.Vadjustment = ViewRight.ScrolledWindow.Vadjustment;
						
						ViewLeft.UpdateControls ();

					};

					ViewRight.ComboBox.Changed += delegate {

						RevisionImage revision_image;
						revision_image = new RevisionImage (file_path, Revisions [ViewRight.ComboBox.Active]);
						ViewRight.SetImage (revision_image);

						HookUpViews ();

						ViewRight.ScrolledWindow.Hadjustment = ViewLeft.ScrolledWindow.Hadjustment;
						ViewRight.ScrolledWindow.Vadjustment = ViewLeft.ScrolledWindow.Vadjustment;

						ViewRight.UpdateControls ();

					};


				layout_horizontal.PackStart (ViewLeft);
				layout_horizontal.PackStart (ViewRight);

				// Order time view according to the user's reading direction
				if (Direction == Gtk.TextDirection.Rtl) // See Deejay1? I can do i18n too! :P				
					layout_horizontal.ReorderChild (ViewLeft, 1);


				HookUpViews ();

				HButtonBox dialog_buttons  = new HButtonBox ();
				dialog_buttons.Layout      = ButtonBoxStyle.End;
				dialog_buttons.BorderWidth = 0;

					Button CloseButton = new Button (Stock.Close);
					CloseButton.Clicked += delegate (object o, EventArgs args) {
						Environment.Exit (0);
					};

				dialog_buttons.Add (CloseButton);

			layout_vertical.PackStart (layout_horizontal, true, true, 0);
			layout_vertical.PackStart (dialog_buttons, false, false, 0);

			Add (layout_vertical);

		}


		// Hooks up two views so their scrollbars will be kept in sync
		private void HookUpViews () {

			ViewLeft.ScrolledWindow.Hadjustment.ValueChanged  += SyncViewsHorizontally;
			ViewLeft.ScrolledWindow.Vadjustment.ValueChanged  += SyncViewsVertically;
			ViewRight.ScrolledWindow.Hadjustment.ValueChanged += SyncViewsHorizontally;
			ViewRight.ScrolledWindow.Vadjustment.ValueChanged += SyncViewsVertically;
		
		}


		// Keeps the two image views in sync horizontally
		private void SyncViewsHorizontally (object o, EventArgs args) {

			Adjustment source_adjustment = (Adjustment) o;
			
			if (source_adjustment == ViewLeft.ScrolledWindow.Hadjustment)
				ViewRight.ScrolledWindow.Hadjustment = source_adjustment;
			else
				ViewLeft.ScrolledWindow.Hadjustment = source_adjustment;			

		}


		// Keeps the two image views in sync vertically
		private void SyncViewsVertically (object o, EventArgs args) {

			Adjustment source_adjustment = (Adjustment) o;

			if (source_adjustment == ViewLeft.ScrolledWindow.Vadjustment)
				ViewRight.ScrolledWindow.Vadjustment = source_adjustment;
			else
				ViewLeft.ScrolledWindow.Vadjustment = source_adjustment;			

		}


		// Gets a list of all earlier revisions of this file
		private string [] GetRevisionsForFilePath (string file_path)
		{

			string file_name = System.IO.Path.GetFileName (file_path);

			Process process = new Process ();
			process.EnableRaisingEvents = true; 
			process.StartInfo.RedirectStandardOutput = true;
			process.StartInfo.UseShellExecute = false;

			// TODO: Nice commit summary and "Current Revision"
			process.StartInfo.WorkingDirectory = System.IO.Path.GetDirectoryName (file_path);
			process.StartInfo.FileName = "git";
			process.StartInfo.Arguments = "log --format=\"%H\" " + file_name;
			process.Start ();

			string output = process.StandardOutput.ReadToEnd ();
			string [] revisions = Regex.Split (output.Trim (), "\n");

			return revisions;

		}


		// Converts a UNIX timestamp to a more usable time object
		public DateTime UnixTimestampToDateTime (int timestamp)
		{
			DateTime unix_epoch = new DateTime (1970, 1, 1, 0, 0, 0, 0);
			return unix_epoch.AddSeconds (timestamp);
		}


		// Quits the program		
		private void Quit (object o, EventArgs args) {

			Environment.Exit (0);

		}


	}


	// An image grabbed from a stream generated by Git
	public class RevisionImage : Image
	{
	
		public string Revision;
		public string FilePath;
	
		public RevisionImage (string file_path, string revision) : base ()
		{
		
			Revision = revision;
			FilePath = file_path;

			Process process = new Process ();
			process.EnableRaisingEvents = true; 
			process.StartInfo.RedirectStandardOutput = true;
			process.StartInfo.UseShellExecute = false;

			process.StartInfo.WorkingDirectory = System.IO.Path.GetDirectoryName (FilePath);
			process.StartInfo.FileName = "git";
			process.StartInfo.Arguments = "show " + revision + ":" + System.IO.Path.GetFileName (FilePath);
			process.Start ();

			Pixbuf = new Gdk.Pixbuf ((System.IO.Stream) process.StandardOutput.BaseStream);
		
		}
	
	}


	// A custom widget containing an image view,
	// previous/next buttons and a combobox
	public class RevisionView : VBox
	{

		public ScrolledWindow ScrolledWindow;
		public ComboBox ComboBox;
		public Button ButtonPrevious;
		public Button ButtonNext;
		
		private int ValueCount;
		private Image Image;

		public RevisionView (string [] revisions) : base (false, 6) 
		{

			Image = new Image ();

			ScrolledWindow = new ScrolledWindow ();

			ScrolledWindow.AddWithViewport (Image);

			HBox controls = new HBox (false, 3);
			controls.BorderWidth = 0;
				
				Arrow arrow_left = new Arrow (ArrowType.Left, ShadowType.None);
				ButtonPrevious = new Button ();
				ButtonPrevious.Add (arrow_left);
				ButtonPrevious.Clicked += PreviousInComboBox;
				ButtonPrevious.ExposeEvent += EqualizeSizes;

				ValueCount = 0;

				ComboBox = ComboBox.NewText ();

				foreach (string revision in revisions) {
					ComboBox.AppendText (revision);
				}

				ComboBox.Active = 0;
				
				ValueCount = revisions.Length;

				Arrow arrow_right = new Arrow (ArrowType.Right, ShadowType.None);
				ButtonNext = new Button ();
				ButtonNext.Add (arrow_right);
				ButtonNext.Clicked += NextInComboBox;
				ButtonNext.ExposeEvent += EqualizeSizes;

			controls.PackStart (new Label (""), true, false, 0);
			controls.PackStart (ButtonPrevious, false, false, 0);
			controls.PackStart (ButtonNext, false, false, 0);
			controls.PackStart (ComboBox, false, false, 9);
			controls.PackStart (new Label (""), true, false, 0);

			PackStart (controls, false, false, 0);
			PackStart (ScrolledWindow, true, true, 0);

			UpdateControls ();

		}


		// Equalizes the height and width of a button when exposed
		private void EqualizeSizes (object o, ExposeEventArgs args) {

			Button button = (Button) o;
			button.WidthRequest = button.Allocation.Height;

		}
		

		public void NextInComboBox (object o, EventArgs args) {

			if (ComboBox.Active - 1 >= 0)
				ComboBox.Active--;

			UpdateControls ();

		}
	

		public void PreviousInComboBox (object o, EventArgs args) {

			if (ComboBox.Active + 1 < ValueCount)
				ComboBox.Active++;

			UpdateControls ();

		}


		// Updates the buttons to be disabled or enabled when needed
		public void UpdateControls () {

			ButtonPrevious.State = StateType.Normal;
			ButtonNext.State     = StateType.Normal;

			// TODO: Disable Next or Previous buttons when at the first or last value of the combobox

		}


		// Changes the image that is viewed
		public void SetImage (Image image) {

			Image = image;
			Remove (ScrolledWindow);
			ScrolledWindow = new ScrolledWindow ();
			ScrolledWindow.AddWithViewport (Image);
			Add (ScrolledWindow);
			ShowAll ();

		}

	}

	
	public class LeftRevisionView : RevisionView {
	
		public LeftRevisionView (string [] revisions) : base (revisions) {

			ComboBox.Active  = 1;

			if (Direction == Gtk.TextDirection.Ltr)
				ScrolledWindow.Placement = CornerType.TopRight;
			else
				ScrolledWindow.Placement = CornerType.TopLeft;

		}
	
	}


	public class RightRevisionView : RevisionView {
	
		public RightRevisionView (string [] revisions) : base (revisions) {

			ComboBox.Active  = 0;

			if (Direction == Gtk.TextDirection.Ltr)
				ScrolledWindow.Placement = CornerType.TopLeft;
			else
				ScrolledWindow.Placement = CornerType.TopRight;

		}
	
	}

}