1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
|
// --------------------------------------------------------------------------------------------------------------------
// <copyright file="EncodeBase.cs" company="HandBrake Project (http://handbrake.fr)">
// This file is part of the HandBrake source code - It may be used under the terms of the GNU General Public License.
// </copyright>
// <summary>
// A Base Class for the Encode Services.
// </summary>
// --------------------------------------------------------------------------------------------------------------------
namespace HandBrake.ApplicationServices.Services.Encode
{
using System;
using System.Diagnostics;
using System.IO;
using System.Text;
using HandBrake.ApplicationServices.Exceptions;
using HandBrake.ApplicationServices.Model;
using HandBrake.ApplicationServices.Services.Encode.EventArgs;
using HandBrake.ApplicationServices.Services.Encode.Interfaces;
using HandBrake.ApplicationServices.Services.Encode.Model;
using HandBrake.ApplicationServices.Utilities;
/// <summary>
/// A Base Class for the Encode Services.
/// </summary>
public class EncodeBase
{
#region Private Variables
/// <summary>
/// A Lock for the filewriter
/// </summary>
private static readonly object FileWriterLock = new object();
/// <summary>
/// The Log File Header
/// </summary>
private readonly StringBuilder header;
/// <summary>
/// The Log Buffer
/// </summary>
private StringBuilder logBuffer;
/// <summary>
/// The Log file writer
/// </summary>
private StreamWriter fileWriter;
#endregion
/// <summary>
/// Initializes a new instance of the <see cref="EncodeBase"/> class.
/// </summary>
public EncodeBase()
{
this.logBuffer = new StringBuilder();
this.header = GeneralUtilities.CreateLogHeader();
this.LogIndex = 0;
}
#region Events
/// <summary>
/// Fires when a new QueueTask starts
/// </summary>
public event EventHandler EncodeStarted;
/// <summary>
/// Fires when a QueueTask finishes.
/// </summary>
public event EncodeCompletedStatus EncodeCompleted;
/// <summary>
/// Encode process has progressed
/// </summary>
public event EncodeProgessStatus EncodeStatusChanged;
#endregion
#region Properties
/// <summary>
/// Gets or sets a value indicating whether IsEncoding.
/// </summary>
public bool IsEncoding { get; protected set; }
/// <summary>
/// Gets ActivityLog.
/// </summary>
public string ActivityLog
{
get
{
string noLog = "There is no log information to display." + Environment.NewLine + Environment.NewLine
+ "This window will only display logging information after you have started an encode." + Environment.NewLine
+ Environment.NewLine + "You can find previous log files in the log directory or by clicking the 'Open Log Directory' button above.";
return string.IsNullOrEmpty(this.logBuffer.ToString())
? noLog
: this.header + this.logBuffer.ToString();
}
}
/// <summary>
/// Gets the log index.
/// </summary>
public int LogIndex { get; private set; }
/// <summary>
/// Gets LogBuffer.
/// </summary>
public StringBuilder LogBuffer
{
get
{
return this.logBuffer;
}
}
#endregion
#region Invoke Events
/// <summary>
/// Invoke the Encode Status Changed Event.
/// </summary>
/// <param name="e">
/// The EncodeProgressEventArgs.
/// </param>
public void InvokeEncodeStatusChanged(EncodeProgressEventArgs e)
{
EncodeProgessStatus handler = this.EncodeStatusChanged;
if (handler != null)
{
handler(this, e);
}
}
/// <summary>
/// Invoke the Encode Completed Event
/// </summary>
/// <param name="e">
/// The EncodeCompletedEventArgs.
/// </param>
public void InvokeEncodeCompleted(EncodeCompletedEventArgs e)
{
EncodeCompletedStatus handler = this.EncodeCompleted;
if (handler != null)
{
handler(this, e);
}
this.LogIndex = 0; // Reset
}
/// <summary>
/// Invoke the Encode Started Event
/// </summary>
/// <param name="e">
/// The EventArgs.
/// </param>
public void InvokeEncodeStarted(System.EventArgs e)
{
EventHandler handler = this.EncodeStarted;
if (handler != null)
{
handler(this, e);
}
}
#endregion
#region Methods
/// <summary>
/// Save a copy of the log to the users desired location or a default location
/// if this feature is enabled in options.
/// </summary>
/// <param name="destination">
/// The Destination File Path
/// </param>
/// <param name="configuration">
/// The configuration.
/// </param>
public void ProcessLogs(string destination, HBConfiguration configuration)
{
try
{
string logDir = Environment.GetFolderPath(Environment.SpecialFolder.ApplicationData) +
"\\HandBrake\\logs";
string tempLogFile = Path.Combine(logDir, string.Format("last_encode_log{0}.txt", GeneralUtilities.ProcessId));
string encodeDestinationPath = Path.GetDirectoryName(destination);
string destinationFile = Path.GetFileName(destination);
string encodeLogFile = destinationFile + " " +
DateTime.Now.ToString().Replace("/", "-").Replace(":", "-") + ".txt";
// Make sure the log directory exists.
if (!Directory.Exists(logDir))
{
Directory.CreateDirectory(logDir);
}
// Copy the Log to HandBrakes log folder in the users applciation data folder.
File.Copy(tempLogFile, Path.Combine(logDir, encodeLogFile));
// Save a copy of the log file in the same location as the enocde.
if (configuration.SaveLogWithVideo)
{
File.Copy(tempLogFile, Path.Combine(encodeDestinationPath, encodeLogFile));
}
// Save a copy of the log file to a user specified location
if (Directory.Exists(configuration.SaveLogCopyDirectory) && configuration.SaveLogToCopyDirectory)
{
File.Copy(
tempLogFile, Path.Combine(configuration.SaveLogCopyDirectory, encodeLogFile));
}
}
catch (Exception exc)
{
Debug.WriteLine(exc); // This exception doesn't warrent user interaction, but it should be logged
}
}
/// <summary>
/// Setup the logging.
/// </summary>
protected void SetupLogging()
{
this.ShutdownFileWriter();
string logDir = Environment.GetFolderPath(Environment.SpecialFolder.ApplicationData) + "\\HandBrake\\logs";
string logFile = Path.Combine(logDir, string.Format("last_encode_log{0}.txt", GeneralUtilities.ProcessId));
string logFile2 = Path.Combine(logDir, string.Format("tmp_appReadable_log{0}.txt", GeneralUtilities.ProcessId));
try
{
this.logBuffer = new StringBuilder();
this.logBuffer.AppendLine();
// Clear the current Encode Logs)
if (File.Exists(logFile))
{
File.Delete(logFile);
}
if (File.Exists(logFile2))
{
File.Delete(logFile2);
}
lock (FileWriterLock)
{
this.fileWriter = new StreamWriter(logFile) { AutoFlush = true };
this.fileWriter.WriteLine(this.header);
this.fileWriter.WriteLine();
}
}
catch (Exception)
{
if (this.fileWriter != null)
{
lock (FileWriterLock)
{
this.fileWriter.Flush();
this.fileWriter.Close();
this.fileWriter.Dispose();
}
}
throw;
}
}
/// <summary>
/// The service log message.
/// </summary>
/// <param name="message">
/// The message.
/// </param>
protected void ServiceLogMessage(string message)
{
this.ProcessLogMessage(string.Format("# {0}", message));
}
/// <summary>
/// Process an Incomming Log Message.
/// </summary>
/// <param name="message">
/// The message.
/// </param>
protected void ProcessLogMessage(string message)
{
if (!string.IsNullOrEmpty(message))
{
try
{
this.LogIndex = this.LogIndex + 1;
lock (this.LogBuffer)
{
this.LogBuffer.AppendLine(message);
}
lock (FileWriterLock)
{
if (this.fileWriter != null && this.fileWriter.BaseStream.CanWrite)
{
this.fileWriter.WriteLine(message);
}
}
}
catch (Exception exc)
{
Debug.WriteLine(exc); // This exception doesn't warrent user interaction, but it should be logged
}
}
}
/// <summary>
/// Shutdown and Dispose of the File Writer.
/// </summary>
protected void ShutdownFileWriter()
{
try
{
lock (FileWriterLock)
{
if (this.fileWriter != null)
{
this.fileWriter.Flush();
this.fileWriter.Close();
this.fileWriter.Dispose();
}
this.fileWriter = null;
}
}
catch (Exception exc)
{
Debug.WriteLine(exc); // This exception doesn't warrent user interaction, but it should be logged
}
}
/// <summary>
/// Verify the Encode Destination path exists and if not, create it.
/// </summary>
/// <param name="task">
/// The task.
/// </param>
/// <exception cref="Exception">
/// If the creation fails, an exception is thrown.
/// </exception>
protected void VerifyEncodeDestinationPath(EncodeTask task)
{
// Make sure the path exists, attempt to create it if it doesn't
try
{
string path = Directory.GetParent(task.Destination).ToString();
if (!Directory.Exists(path))
{
Directory.CreateDirectory(path);
}
}
catch (Exception exc)
{
throw new GeneralApplicationException(
"Unable to create directory for the encoded output.", "Please verify that you have a valid path.", exc);
}
}
#endregion
}
}
|