win/C#/frmActivityWindow.cs

   1 /*  frmActivityWindow.cs $\r
   2         \r
   3            This file is part of the HandBrake source code.\r
   4            Homepage: <http://handbrake.fr>.\r
   5            It may be used under the terms of the GNU General Public License. */\r
   6 \r
   7 using System;\r
   8 using System.Collections;\r
   9 using System.Collections.Generic;\r
  10 using System.ComponentModel;\r
  11 using System.Data;\r
  12 using System.Drawing;\r
  13 using System.Text;\r
  14 using System.Windows.Forms;\r
  15 using System.IO;\r
  16 using System.Threading;\r
  17 using System.Diagnostics;\r
  18 using System.Runtime.InteropServices;\r
  19 \r
  20 \r
  21 namespace Handbrake\r
  22 {\r
  23     public partial class frmActivityWindow : Form\r
  24     {\r
  25         delegate void SetTextCallback(string text);\r
  26         String read_file;\r
  27         Thread monitor;\r
  28         frmMain mainWindow;\r
  29         frmQueue queueWindow;\r
  30         int position = 0;  // Position in the arraylist reached by the current log output in the rtf box.\r
  31 \r
  32         /// <summary>\r
  33         /// This window should be used to display the RAW output of the handbrake CLI which is produced during an encode.\r
  34         /// </summary>\r
  35         public frmActivityWindow(string file, frmMain fm, frmQueue fq)\r
  36         {\r
  37             InitializeComponent();\r
  38             this.rtf_actLog.Text = string.Empty;\r
  39 \r
  40             mainWindow = fm;\r
  41             queueWindow = fq;\r
  42             read_file = file;\r
  43             position = 0;\r
  44 \r
  45             // Print the Log header in the Rich text box.\r
  46             displayLogHeader();\r
  47 \r
  48             // Start a new thread which will montior and keep the log window up to date if required/\r
  49             startLogThread(read_file);\r
  50 \r
  51             if (file == "dvdinfo.dat")\r
  52                 txt_log.Text = "Scan Log";\r
  53             else if (file == "hb_encode_log.dat")\r
  54                 txt_log.Text = "Encode Log";\r
  55 \r
  56 \r
  57             // When the window closes, we want to abort the monitor thread.\r
  58             this.Disposed += new EventHandler(forceQuit);\r
  59         }\r
  60 \r
  61         /// <summary>\r
  62         /// Displays the Log header\r
  63         /// </summary>\r
  64         private void displayLogHeader()\r
  65         {\r
  66             // System Information\r
  67             Functions.SystemInfo info = new Functions.SystemInfo();\r
  68 \r
  69             // Add a header to the log file indicating that it's from the Windows GUI and display the windows version\r
  70             rtf_actLog.AppendText(String.Format("### Windows GUI {1} {0} \n", Properties.Settings.Default.hb_build, Properties.Settings.Default.hb_version));\r
  71             rtf_actLog.AppendText(String.Format("### Running: {0} \n###\n", Environment.OSVersion.ToString()));\r
  72             rtf_actLog.AppendText(String.Format("### CPU: {0} \n", info.getCpuCount()));\r
  73             rtf_actLog.AppendText(String.Format("### Ram: {0} MB \n", info.TotalPhysicalMemory()));\r
  74             rtf_actLog.AppendText(String.Format("### Screen: {0}x{1} \n", info.screenBounds().Bounds.Width, info.screenBounds().Bounds.Height));\r
  75             rtf_actLog.AppendText(String.Format("### Temp Dir: {0} \n", Path.GetTempPath()));\r
  76             rtf_actLog.AppendText(String.Format("### Install Dir: {0} \n", Application.StartupPath));\r
  77             rtf_actLog.AppendText(String.Format("### Data Dir: {0} \n", Application.UserAppDataPath));\r
  78             rtf_actLog.AppendText("#########################################\n\n");\r
  79         }\r
  80 \r
  81         /// <summary>\r
  82         /// Starts a new thread which runs the autoUpdate function.\r
  83         /// </summary>\r
  84         /// <param name="file"> File which will be used to populate the Rich text box.</param>\r
  85         private void startLogThread(string file)\r
  86         {\r
  87             string logFile = Path.Combine(Path.GetTempPath(), file);\r
  88             if (File.Exists(logFile))\r
  89             {\r
  90                 // Start a new thread to run the autoUpdate process\r
  91                 monitor = new Thread(autoUpdate);\r
  92                 monitor.IsBackground = true;\r
  93                 monitor.Start();\r
  94             }\r
  95             else\r
  96                 rtf_actLog.AppendText("\n\n\nERROR: The log file could not be found. \nMaybe you cleared your system's tempory folder or maybe you just havn't run an encode yet. \nTried to find the log file in: " + logFile);\r
  97         }\r
  98 \r
  99         /// <summary>\r
 100         /// Change the log file to be displayed to hb_encode_log.dat\r
 101         /// </summary>\r
 102         /// <param name="sender"></param>\r
 103         /// <param name="e"></param>\r
 104         private void btn_scan_log_Click(object sender, EventArgs e)\r
 105         {\r
 106             if (monitor != null)\r
 107                 monitor.Abort();\r
 108 \r
 109             rtf_actLog.Clear();\r
 110             read_file = "dvdinfo.dat";\r
 111             displayLogHeader();\r
 112             startLogThread(read_file);\r
 113             txt_log.Text = "Scan Log";\r
 114         }\r
 115 \r
 116         /// <summary>\r
 117         /// Change the log file to be displayed to dvdinfo.dat\r
 118         /// </summary>\r
 119         /// <param name="sender"></param>\r
 120         /// <param name="e"></param>\r
 121         private void btn_encode_log_Click(object sender, EventArgs e)\r
 122         {\r
 123             if (monitor != null)\r
 124                 monitor.Abort();\r
 125 \r
 126             rtf_actLog.Clear();\r
 127             read_file = "hb_encode_log.dat";\r
 128             position = 0;\r
 129             displayLogHeader();\r
 130             startLogThread(read_file);\r
 131             txt_log.Text = "Encode Log";\r
 132         }\r
 133 \r
 134         /// <summary>\r
 135         /// Copy to Clipboard\r
 136         /// </summary>\r
 137         /// <param name="sender"></param>\r
 138         /// <param name="e"></param>\r
 139         private void btn_copy_Click(object sender, EventArgs e)\r
 140         {\r
 141             if (rtf_actLog.SelectedText != "")\r
 142                 Clipboard.SetDataObject(rtf_actLog.SelectedText, true);\r
 143             else\r
 144                 Clipboard.SetDataObject(rtf_actLog.Text, true);\r
 145         }\r
 146 \r
 147         /// <summary>\r
 148         /// Updates the log window with any new data which is in the log file.\r
 149         /// This is done every 5 seconds.\r
 150         /// </summary>\r
 151         /// <param name="state"></param>\r
 152         private void autoUpdate(object state)\r
 153         {\r
 154             Boolean lastUpdate = false;\r
 155             updateTextFromThread();\r
 156             while (true)\r
 157             {\r
 158                 if ((mainWindow.isEncoding() == true) || (queueWindow.isEncoding() == true))\r
 159                     updateTextFromThread();\r
 160                 else\r
 161                 {\r
 162                     // The encode may just have stoped, so, refresh the log one more time before restarting it.\r
 163                     if (lastUpdate == false)\r
 164                         updateTextFromThread();\r
 165 \r
 166                     lastUpdate = true; // Prevents the log window from being updated when there is no encode going.\r
 167                     position = 0; // There is no encoding, so reset the log position counter to 0 so it can be reused\r
 168                 }\r
 169                 Thread.Sleep(5000);\r
 170             }\r
 171         }\r
 172 \r
 173         /// <summary>\r
 174         /// Finds any new text in the log file and calls a funciton to display this new text.\r
 175         /// </summary>\r
 176         private void updateTextFromThread()\r
 177         {\r
 178             string text = "";\r
 179             List<string> data = readFile();\r
 180             int count = data.Count;\r
 181 \r
 182             while (position < count)\r
 183             {\r
 184                 text = data[position].ToString();\r
 185                 if (data[position].ToString().Contains("has exited"))\r
 186                     text = "\n ############ End of Log ############## \n";\r
 187                 position++;\r
 188 \r
 189                 SetText(text);\r
 190             }\r
 191         }\r
 192 \r
 193         /// <summary>\r
 194         /// Updates the rich text box with anything in the string text.\r
 195         /// </summary>\r
 196         /// <param name="text"></param>\r
 197         private void SetText(string text)\r
 198         {\r
 199             // InvokeRequired required compares the thread ID of the\r
 200             // calling thread to the thread ID of the creating thread.\r
 201             // If these threads are different, it returns true.\r
 202             if (this.rtf_actLog.InvokeRequired)\r
 203             {\r
 204                 SetTextCallback d = new SetTextCallback(SetText);\r
 205                 this.Invoke(d, new object[] { text });\r
 206             }\r
 207             else\r
 208             {\r
 209                 this.rtf_actLog.AppendText(text);\r
 210             }\r
 211         }\r
 212 \r
 213         /// <summary>\r
 214         /// Read the log file, and store the data in a List.\r
 215         /// </summary>\r
 216         /// <returns></returns>\r
 217         private List<string> readFile()\r
 218         {\r
 219             // Ok, the task here is to, Get an arraylist of log data.\r
 220             // And update some global varibles which are pointers to the last displayed log line.\r
 221             List<string> logData = new List<string>();\r
 222 \r
 223             try\r
 224             {\r
 225                 // 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
 226                 // we'll need to make a copy of it.\r
 227                 string logFile = Path.Combine(Path.GetTempPath(), read_file);\r
 228                 string logFile2 = Path.Combine(Path.GetTempPath(), "hb_encode_log_AppReadable.dat");\r
 229 \r
 230                 // Make sure the application readable log file does not already exist. FileCopy fill fail if it does.\r
 231                 if (File.Exists(logFile2))\r
 232                     File.Delete(logFile2);\r
 233 \r
 234                 // Copy the log file.\r
 235                 File.Copy(logFile, logFile2);\r
 236 \r
 237                 // Open the copied log file for reading\r
 238                 StreamReader sr = new StreamReader(logFile2);\r
 239                 string line = sr.ReadLine();\r
 240                 while (line != null)\r
 241                 {\r
 242                     if (line.Trim() != "")\r
 243                         logData.Add(line + System.Environment.NewLine);\r
 244 \r
 245                     line = sr.ReadLine();\r
 246                 }\r
 247                 sr.Close();\r
 248                 sr.Dispose();\r
 249 \r
 250                 return logData;\r
 251             }\r
 252             catch (Exception exc)\r
 253             {\r
 254                 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
 255             }\r
 256             return null;\r
 257         }\r
 258 \r
 259         /// <summary>\r
 260         /// Kills the montior thead when the window is disposed of.\r
 261         /// </summary>\r
 262         /// <param name="sender"></param>\r
 263         /// <param name="e"></param>\r
 264         private void forceQuit(object sender, EventArgs e)\r
 265         {\r
 266             if (monitor != null)\r
 267                 monitor.Abort();\r
 268 \r
 269             this.Close();\r
 270         }\r
 271     }\r
 272 }