/* frmActivityWindow.cs $\r
- \r
- This file is part of the HandBrake source code.\r
- Homepage: <http://handbrake.fr>.\r
- It may be used under the terms of the GNU General Public License. */\r
+ This file is part of the HandBrake source code.\r
+ Homepage: <http://handbrake.fr>.\r
+ It may be used under the terms of the GNU General Public License. */\r
\r
-using System;\r
-using System.Collections;\r
-using System.ComponentModel;\r
-using System.Data;\r
-using System.Drawing;\r
-using System.Text;\r
-using System.Windows.Forms;\r
-using System.IO;\r
-using System.Threading;\r
-using System.Diagnostics;\r
-using System.Runtime.InteropServices;\r
+namespace Handbrake\r
+{\r
+ using System;\r
+ using System.ComponentModel;\r
+ using System.Diagnostics;\r
+ using System.IO;\r
+ using System.Text;\r
+ using System.Threading;\r
+ using System.Windows.Forms;\r
\r
+ using HandBrake.ApplicationServices.Services.Interfaces;\r
\r
+ using Model;\r
+ using Timer = System.Threading.Timer;\r
\r
-namespace Handbrake\r
-{\r
+ /// <summary>\r
+ /// The Activity Log Window\r
+ /// </summary>\r
public partial class frmActivityWindow : Form\r
{\r
+ /* Private Variables */\r
+\r
+ /// <summary>\r
+ /// The current position in the log file\r
+ /// </summary>\r
+ private int position;\r
+\r
+ /// <summary>\r
+ /// A Timer for this window\r
+ /// </summary>\r
+ private Timer windowTimer;\r
+\r
+ /// <summary>\r
+ /// The Encode Object\r
+ /// </summary>\r
+ private IQueue encode;\r
+\r
+ /// <summary>\r
+ /// The Scan Object\r
+ /// </summary>\r
+ private IScan scan;\r
+\r
+ /// <summary>\r
+ /// The Type of log that the window is currently dealing with\r
+ /// </summary>\r
+ private ActivityLogMode mode;\r
\r
- Thread monitorFile;\r
- String read_file;\r
- frmMain mainWindow;\r
- frmQueue queueWindow;\r
- int position = 0; // Position in the arraylist reached by the current log output in the rtf box.\r
- \r
+ /* Constructor */\r
\r
/// <summary>\r
- /// This window should be used to display the RAW output of the handbrake CLI which is produced during an encode.\r
+ /// Initializes a new instance of the <see cref="frmActivityWindow"/> class.\r
/// </summary>\r
- /// \r
- public frmActivityWindow(string file, frmMain fm, frmQueue fq)\r
+ /// <param name="encode">\r
+ /// The encode.\r
+ /// </param>\r
+ /// <param name="scan">\r
+ /// The scan.\r
+ /// </param>\r
+ public frmActivityWindow(IQueue encode, IScan scan)\r
{\r
InitializeComponent();\r
\r
- mainWindow = fm;\r
- queueWindow = fq;\r
- read_file = file;\r
+ this.encode = encode;\r
+ this.scan = scan;\r
+ this.position = 0;\r
\r
- // Reset some varibles\r
- this.rtf_actLog.Text = string.Empty;\r
- position = 0;\r
+ // Listen for Scan and Encode Starting Events\r
+ scan.ScanStared += scan_ScanStared;\r
+ encode.EncodeStarted += encode_EncodeStarted;\r
+ }\r
+\r
+ /* Delegates */\r
+\r
+ /// <summary>\r
+ /// A callback function for updating the ui\r
+ /// </summary>\r
+ /// <param name="text">\r
+ /// The text.\r
+ /// </param>\r
+ private delegate void SetTextCallback(StringBuilder text);\r
+\r
+ /// <summary>\r
+ /// Clear text callback\r
+ /// </summary>\r
+ private delegate void SetTextClearCallback();\r
+\r
+ /// <summary>\r
+ /// Set mode callback\r
+ /// </summary>\r
+ /// <param name="setMode">\r
+ /// The set mode.\r
+ /// </param>\r
+ private delegate void SetModeCallback(ActivityLogMode setMode);\r
+\r
+ /* Private Methods */\r
\r
- string logFile = Path.Combine(Path.GetTempPath(), read_file);\r
- if (File.Exists(logFile))\r
+ /// <summary>\r
+ /// Set the window to scan mode\r
+ /// </summary>\r
+ /// <param name="setMode">\r
+ /// The set Mode.\r
+ /// </param>\r
+ private void SetMode(ActivityLogMode setMode)\r
+ {\r
+ if (IsHandleCreated)\r
{\r
- // Add a header to the log file indicating that it's from the Windows GUI and display the windows version\r
- rtf_actLog.AppendText("### Windows GUI \n");\r
- rtf_actLog.AppendText(String.Format("### Running: {0} \n###\n", Environment.OSVersion.ToString()));\r
+ if (rtf_actLog.InvokeRequired)\r
+ {\r
+ IAsyncResult invoked = BeginInvoke(new SetModeCallback(SetMode), new object[] {setMode});\r
+ EndInvoke(invoked);\r
+ }\r
+ else\r
+ {\r
+ Reset();\r
+ this.mode = setMode;\r
+\r
+ Array values = Enum.GetValues(typeof(ActivityLogMode));\r
+ Properties.Settings.Default.ActivityWindowLastMode = (int) values.GetValue(Convert.ToInt32(setMode));\r
+ Properties.Settings.Default.Save();\r
+\r
+ this.Text = mode == ActivityLogMode.Scan\r
+ ? "Activity Window (Scan Log)"\r
+ : "Activity Window (Encode Log)";\r
+\r
+ if (mode == ActivityLogMode.Scan)\r
+ {\r
+ scan.ScanCompleted += stopWindowRefresh;\r
+ encode.EncodeEnded -= stopWindowRefresh;\r
+ }\r
+ else\r
+ {\r
+ scan.ScanCompleted -= stopWindowRefresh;\r
+ encode.EncodeEnded += stopWindowRefresh;\r
+ }\r
\r
- // Start a new thread to run the autoUpdate process\r
- monitorFile = new Thread(autoUpdate);\r
- monitorFile.Start();\r
+ // Start a fresh window timer\r
+ windowTimer = new Timer(new TimerCallback(LogMonitor), null, 1000, 1000);\r
+ }\r
}\r
- else\r
- MessageBox.Show("The log file could not be found. Maybe you cleared your system's tempory folder or maybe you just havn't run an encode yet.", "Notice", MessageBoxButtons.OK, MessageBoxIcon.Warning);\r
+ }\r
+\r
+ /// <summary>\r
+ /// On Window load, start a new timer\r
+ /// </summary>\r
+ /// <param name="sender">\r
+ /// The sender.\r
+ /// </param>\r
+ /// <param name="e">\r
+ /// The e.\r
+ /// </param>\r
+ private void NewActivityWindow_Load(object sender, EventArgs e)\r
+ {\r
+ ActivityLogMode activitLogMode = (ActivityLogMode) Enum.ToObject(typeof(ActivityLogMode), Properties.Settings.Default.ActivityWindowLastMode);\r
+ SetMode(activitLogMode); \r
+ }\r
\r
- // Handle the event of the window being disposed. This is needed to make sure HandBrake exit's cleanly.\r
- this.Disposed += new EventHandler(forceQuit);\r
+ /// <summary>\r
+ /// Set the Log window to encode mode when an encode starts.\r
+ /// </summary>\r
+ /// <param name="sender">\r
+ /// The sender.\r
+ /// </param>\r
+ /// <param name="e">\r
+ /// The e.\r
+ /// </param>\r
+ private void encode_EncodeStarted(object sender, EventArgs e)\r
+ {\r
+ SetMode(ActivityLogMode.Encode);\r
}\r
\r
- // Ok, so, this function is called when someone closes frmMain but didn't close frmActivitWindow first.\r
- // When you close frmMain, the activity window gets closed (disposed of) but, this doens't kill the threads that it started.\r
- // When that thread tries to access the disposed rich text box, it causes an exception.\r
- // Basically, this function is called when the window is disposed of, to kill the thread and close the window properly.\r
- // This allows HandBrake to close cleanly.\r
- private void forceQuit(object sender, EventArgs e)\r
+ /// <summary>\r
+ /// Set the log widow to scan mode when a scan starts\r
+ /// </summary>\r
+ /// <param name="sender">\r
+ /// The sender.\r
+ /// </param>\r
+ /// <param name="e">\r
+ /// The e.\r
+ /// </param>\r
+ private void scan_ScanStared(object sender, EventArgs e)\r
+ {\r
+ SetMode(ActivityLogMode.Scan);\r
+ }\r
+\r
+ /// <summary>\r
+ /// Stop refreshing the window when no scanning or encoding is happening.\r
+ /// </summary>\r
+ /// <param name="sender">\r
+ /// The sender.\r
+ /// </param>\r
+ /// <param name="e">\r
+ /// The e.\r
+ /// </param>\r
+ private void stopWindowRefresh(object sender, EventArgs e)\r
{\r
- if (monitorFile != null)\r
- monitorFile.Abort();\r
+ windowTimer.Dispose();\r
+ LogMonitor(null);\r
+ }\r
\r
- this.Close();\r
+ /// <summary>\r
+ /// Append new text to the window\r
+ /// </summary>\r
+ /// <param name="n">\r
+ /// The n.\r
+ /// </param>\r
+ private void LogMonitor(object n)\r
+ {\r
+ AppendWindowText(GetLog());\r
}\r
\r
- // Update the Activity window every 5 seconds with the latest log data.\r
- private void autoUpdate(object state)\r
+ /// <summary>\r
+ /// New Code for getting the Activity log from the Services rather than reading a file.\r
+ /// </summary>\r
+ /// <returns>\r
+ /// The StringBuilder containing a log\r
+ /// </returns>\r
+ private StringBuilder GetLog()\r
{\r
- Boolean lastUpdate = false;\r
- updateTextFromThread();\r
- while (true)\r
- { \r
- if ((mainWindow.isEncoding() == true) || (queueWindow.isEncoding() == true))\r
- updateTextFromThread();\r
- else\r
+ StringBuilder appendText = new StringBuilder();\r
+\r
+ if (this.mode == ActivityLogMode.Scan)\r
+ {\r
+ if (scan == null || scan.ActivityLog == string.Empty)\r
{\r
- // The encode may just have stoped, so, refresh the log one more time before restarting it.\r
- if (lastUpdate == false)\r
- updateTextFromThread();\r
+ appendText.AppendFormat("Waiting for the log to be generated ...\n");\r
+ position = 0;\r
+ ClearWindowText();\r
+ return appendText;\r
+ }\r
\r
- lastUpdate = true;\r
+ using (StringReader reader = new StringReader(scan.ActivityLog))\r
+ {\r
+ LogReader(reader, appendText);\r
+ }\r
+ }\r
+ else\r
+ {\r
+ if (encode == null || encode.ActivityLog == string.Empty)\r
+ {\r
+ appendText.AppendFormat("Waiting for the log to be generated ...\n");\r
position = 0;\r
+ ClearWindowText();\r
+ return appendText;\r
+ }\r
+\r
+ using (StringReader reader = new StringReader(encode.ActivityLog))\r
+ {\r
+ LogReader(reader, appendText);\r
}\r
- Thread.Sleep(5000);\r
}\r
+ return appendText;\r
}\r
\r
- private delegate void UpdateUIHandler();\r
- private void updateTextFromThread()\r
+ /// <summary>\r
+ /// Reads the log data from a Scan or Encode object\r
+ /// </summary>\r
+ /// <param name="reader">\r
+ /// The reader.\r
+ /// </param>\r
+ /// <param name="appendText">\r
+ /// The append text.\r
+ /// </param>\r
+ private void LogReader(StringReader reader, StringBuilder appendText)\r
{\r
- try\r
+ string line;\r
+ int i = 1;\r
+ while ((line = reader.ReadLine()) != null)\r
{\r
- if (this.InvokeRequired)\r
+ if (i > position)\r
{\r
- this.BeginInvoke(new UpdateUIHandler(updateTextFromThread));\r
- return;\r
+ appendText.AppendLine(line);\r
+ position++;\r
}\r
- // Initialize a pointer and get the log data arraylist\r
- ArrayList data = readFile();\r
+ i++;\r
+ }\r
+ }\r
\r
- while (position < data.Count)\r
+ /// <summary>\r
+ /// Append text to the RTF box\r
+ /// </summary>\r
+ /// <param name="text">\r
+ /// The text.\r
+ /// </param>\r
+ private void AppendWindowText(StringBuilder text)\r
+ {\r
+ try\r
+ {\r
+ if (IsHandleCreated)\r
{\r
- rtf_actLog.AppendText(data[position].ToString());\r
- if (data[position].ToString().Contains("has exited"))\r
+ if (rtf_actLog.InvokeRequired)\r
{\r
- rtf_actLog.AppendText("\n ############ End of Encode ############## \n");\r
+ IAsyncResult invoked = BeginInvoke(new SetTextCallback(AppendWindowText), new object[] { text });\r
+ EndInvoke(invoked);\r
}\r
- position++;\r
- }\r
+ else\r
+ lock (rtf_actLog)\r
+ rtf_actLog.AppendText(text.ToString());\r
\r
- // this.rtf_actLog.SelectionStart = this.rtf_actLog.Text.Length - 1;\r
- // this.rtf_actLog.ScrollToCaret();\r
+ // Stop the refresh process if log has finished.\r
+ if (text.ToString().Contains("HandBrake has Exited"))\r
+ {\r
+ windowTimer.Dispose();\r
+ }\r
+ }\r
}\r
- catch (Exception exc)\r
+ catch (Exception)\r
{\r
- MessageBox.Show("An error has occured in: updateTextFromThread(). \n You may have to restart HandBrake. \n Error Information: \n\n" + exc.ToString(), "Error", MessageBoxButtons.OK, MessageBoxIcon.Error);\r
+ return;\r
}\r
}\r
\r
- private ArrayList readFile()\r
+ /// <summary>\r
+ /// Clear the contents of the log window\r
+ /// </summary>\r
+ private void ClearWindowText()\r
{\r
- // Ok, the task here is to, Get an arraylist of log data.\r
- // And update some global varibles which are pointers to the last displayed log line.\r
- ArrayList logData = new ArrayList();\r
-\r
try\r
{\r
- // hb_encode_log.dat is the primary log file. Since .NET can't read this file whilst the CLI is outputing to it (Not even in read only mode),\r
- // we'll need to make a copy of it.\r
- string logFile = Path.Combine(Path.GetTempPath(), read_file);\r
- string logFile2 = Path.Combine(Path.GetTempPath(), "hb_encode_log_AppReadable.dat");\r
-\r
- // Make sure the application readable log file does not already exist. FileCopy fill fail if it does.\r
- if (File.Exists(logFile2))\r
- File.Delete(logFile2);\r
-\r
- // Copy the log file.\r
- File.Copy(logFile, logFile2);\r
-\r
- // Open the copied log file for reading\r
- StreamReader sr = new StreamReader(logFile2);\r
- string line = sr.ReadLine();\r
- while (line != null)\r
+ if (IsHandleCreated)\r
{\r
- if (line.Trim() != "")\r
- logData.Add(line + System.Environment.NewLine);\r
-\r
- line = sr.ReadLine();\r
+ if (rtf_actLog.InvokeRequired)\r
+ {\r
+ IAsyncResult invoked = BeginInvoke(new SetTextClearCallback(ClearWindowText));\r
+ EndInvoke(invoked);\r
+ }\r
+ else\r
+ lock (rtf_actLog)\r
+ rtf_actLog.Clear();\r
}\r
- sr.Close();\r
- sr.Dispose();\r
-\r
- return logData;\r
}\r
- catch (Exception exc)\r
+ catch (Exception)\r
{\r
- MessageBox.Show("Error in readFile() \n Unable to read the log file.\n You may have to restart HandBrake.\n Error Information: \n\n" + exc.ToString(), "Warning", MessageBoxButtons.OK, MessageBoxIcon.Warning);\r
+ return;\r
}\r
- return null;\r
}\r
\r
+ /// <summary>\r
+ /// Reset Everything\r
+ /// </summary>\r
+ private void Reset()\r
+ {\r
+ if (windowTimer != null)\r
+ windowTimer.Dispose();\r
+ position = 0;\r
+ ClearWindowText();\r
+ windowTimer = new Timer(new TimerCallback(LogMonitor), null, 1000, 1000);\r
+ }\r
+\r
+ /* Menus and Buttons */\r
+\r
+ /// <summary>\r
+ /// Copy log to clipboard\r
+ /// </summary>\r
+ /// <param name="sender">\r
+ /// The sender.\r
+ /// </param>\r
+ /// <param name="e">\r
+ /// The e.\r
+ /// </param>\r
+ private void MnuCopyLogClick(object sender, EventArgs e)\r
+ {\r
+ Clipboard.SetDataObject(rtf_actLog.SelectedText != string.Empty ? rtf_actLog.SelectedText : rtf_actLog.Text, true);\r
+ }\r
+\r
+ /// <summary>\r
+ /// Open the log folder\r
+ /// </summary>\r
+ /// <param name="sender">\r
+ /// The sender.\r
+ /// </param>\r
+ /// <param name="e">\r
+ /// The e.\r
+ /// </param>\r
+ private void MnuOpenLogFolderClick(object sender, EventArgs e)\r
+ {\r
+ string logDir = Environment.GetFolderPath(Environment.SpecialFolder.ApplicationData) + "\\HandBrake\\logs";\r
+ string windir = Environment.GetEnvironmentVariable("WINDIR");\r
+ Process prc = new Process\r
+ {\r
+ StartInfo =\r
+ {\r
+ FileName = windir + @"\explorer.exe",\r
+ Arguments = logDir\r
+ }\r
+ };\r
+ prc.Start();\r
+ }\r
+\r
+ /// <summary>\r
+ /// Copy the log\r
+ /// </summary>\r
+ /// <param name="sender">\r
+ /// The sender.\r
+ /// </param>\r
+ /// <param name="e">\r
+ /// The e.\r
+ /// </param>\r
+ private void BtnCopyClick(object sender, EventArgs e)\r
+ {\r
+ Clipboard.SetDataObject(rtf_actLog.SelectedText != string.Empty ? rtf_actLog.SelectedText : rtf_actLog.Text, true);\r
+ }\r
+\r
+ /// <summary>\r
+ /// Set scan mode\r
+ /// </summary>\r
+ /// <param name="sender">\r
+ /// The sender.\r
+ /// </param>\r
+ /// <param name="e">\r
+ /// The e.\r
+ /// </param>\r
+ private void BtnScanLogClick(object sender, EventArgs e)\r
+ {\r
+ SetMode(ActivityLogMode.Scan);\r
+ }\r
+\r
+ /// <summary>\r
+ /// Set the encode mode\r
+ /// </summary>\r
+ /// <param name="sender">\r
+ /// The sender.\r
+ /// </param>\r
+ /// <param name="e">\r
+ /// The e.\r
+ /// </param>\r
+ private void BtnEncodeLogClick(object sender, EventArgs e)\r
+ {\r
+ SetMode(ActivityLogMode.Encode);\r
+ }\r
+\r
+ /* Overrides */\r
\r
- // Ok, We need to make sure the monitor thread is dead when we close the window.\r
+ /// <summary>\r
+ /// override onclosing\r
+ /// </summary>\r
+ /// <param name="e">\r
+ /// The e.\r
+ /// </param>\r
protected override void OnClosing(CancelEventArgs e)\r
{\r
- if (monitorFile != null)\r
- monitorFile.Abort();\r
+ scan.ScanStared -= scan_ScanStared;\r
+ encode.EncodeStarted -= encode_EncodeStarted;\r
+\r
+ scan.ScanCompleted -= stopWindowRefresh;\r
+ encode.EncodeEnded -= stopWindowRefresh;\r
+\r
+ windowTimer.Dispose();\r
e.Cancel = true;\r
- this.Hide();\r
+ this.Dispose();\r
base.OnClosing(e);\r
}\r
-\r
}\r
}
\ No newline at end of file