Office code cleanup, this could improve the COM-object usage a bit.

This commit is contained in:
RKrom 2014-03-17 14:54:27 +01:00
parent 3204b92d53
commit d27df3027b
5 changed files with 252 additions and 188 deletions

View file

@ -133,7 +133,7 @@ namespace GreenshotOfficePlugin {
}
public override IEnumerable<IDestination> DynamicDestinations() {
Dictionary<string, OlObjectClass> inspectorCaptions = OutlookEmailExporter.RetrievePossibleTargets(conf.OutlookAllowExportInMeetings);
Dictionary<string, OlObjectClass> inspectorCaptions = OutlookEmailExporter.RetrievePossibleTargets();
if (inspectorCaptions != null) {
foreach (string inspectorCaption in inspectorCaptions.Keys) {
yield return new OutlookDestination(inspectorCaption, inspectorCaptions[inspectorCaption]);
@ -175,7 +175,7 @@ namespace GreenshotOfficePlugin {
exportInformation.ExportMade = true;
} else {
if (!manuallyInitiated) {
Dictionary<string, OlObjectClass> inspectorCaptions = OutlookEmailExporter.RetrievePossibleTargets(conf.OutlookAllowExportInMeetings);
Dictionary<string, OlObjectClass> inspectorCaptions = OutlookEmailExporter.RetrievePossibleTargets();
if (inspectorCaptions != null && inspectorCaptions.Count > 0) {
List<IDestination> destinations = new List<IDestination>();
destinations.Add(new OutlookDestination());

View file

@ -31,6 +31,8 @@ using System.Threading;
using System.Runtime.InteropServices;
using System.Windows.Forms;
using GreenshotPlugin.Core;
using GreenshotOfficePlugin;
using Greenshot.IniFile;
namespace Greenshot.Interop.Office {
/// <summary>
@ -38,6 +40,7 @@ namespace Greenshot.Interop.Office {
/// </summary>
public class OutlookEmailExporter {
private static readonly log4net.ILog LOG = log4net.LogManager.GetLogger(typeof(OutlookEmailExporter));
private static readonly OfficeConfiguration conf = IniConfig.GetIniSection<OfficeConfiguration>();
private static readonly string SIGNATURE_PATH = Path.Combine(Environment.GetFolderPath(Environment.SpecialFolder.ApplicationData), @"Microsoft\Signatures");
private static Version outlookVersion = null;
private static string currentUser = null;
@ -56,9 +59,8 @@ namespace Greenshot.Interop.Office {
/// <summary>
/// A method to retrieve all inspectors which can act as an export target
/// </summary>
/// <param name="allowMeetingAsTarget">bool true if also exporting to meetings</param>
/// <returns>List<string> with inspector captions (window title)</returns>
public static Dictionary<string, OlObjectClass> RetrievePossibleTargets(bool allowMeetingAsTarget) {
public static Dictionary<string, OlObjectClass> RetrievePossibleTargets() {
Dictionary<string, OlObjectClass> inspectorCaptions = new Dictionary<string, OlObjectClass>();
try {
using (IOutlookApplication outlookApplication = GetOutlookApplication()) {
@ -71,7 +73,7 @@ namespace Greenshot.Interop.Office {
using (var activeExplorer = outlookApplication.ActiveExplorer()) {
if (activeExplorer != null) {
using (var inlineResponse = activeExplorer.ActiveInlineResponse) {
if (canExportToInspector(inlineResponse, allowMeetingAsTarget)) {
if (canExportToInspector(inlineResponse)) {
OlObjectClass currentItemClass = inlineResponse.Class;
inspectorCaptions.Add(activeExplorer.Caption, currentItemClass);
}
@ -86,7 +88,7 @@ namespace Greenshot.Interop.Office {
using (IInspector inspector = outlookApplication.Inspectors[i]) {
string inspectorCaption = inspector.Caption;
using (IItem currentItem = inspector.CurrentItem) {
if (canExportToInspector(currentItem, allowMeetingAsTarget)) {
if (canExportToInspector(currentItem)) {
OlObjectClass currentItemClass = currentItem.Class;
inspectorCaptions.Add(inspector.Caption, currentItemClass);
}
@ -106,9 +108,8 @@ namespace Greenshot.Interop.Office {
/// Return true if we can export to the supplied inspector
/// </summary>
/// <param name="currentItem">the Item to check</param>
/// <param name="allowMeetingAsTarget">bool true if also exporting to meetings</param>
/// <returns></returns>
private static bool canExportToInspector(IItem currentItem, bool allowMeetingAsTarget) {
private static bool canExportToInspector(IItem currentItem) {
try {
if (currentItem != null) {
OlObjectClass currentItemClass = currentItem.Class;
@ -119,7 +120,7 @@ namespace Greenshot.Interop.Office {
if (!mailItem.Sent) {
return true;
}
} else if (outlookVersion.Major >= OUTLOOK_2010 && allowMeetingAsTarget && OlObjectClass.olAppointment.Equals(currentItemClass)) {
} else if (outlookVersion.Major >= OUTLOOK_2010 && conf.OutlookAllowExportInMeetings && OlObjectClass.olAppointment.Equals(currentItemClass)) {
//AppointmentItem appointmentItem = COMWrapper.Cast<AppointmentItem>(currentItem);
AppointmentItem appointmentItem = (AppointmentItem)currentItem;
if (string.IsNullOrEmpty(appointmentItem.Organizer) || (currentUser != null && currentUser.Equals(appointmentItem.Organizer))) {
@ -144,20 +145,21 @@ namespace Greenshot.Interop.Office {
/// <param name="attachmentName">name of the attachment (used as the tooltip of the image)</param>
/// <returns>true if it worked</returns>
public static bool ExportToInspector(string inspectorCaption, string tmpFile, string attachmentName) {
// Assume true, although this might cause issues.
bool allowMeetingAsTarget = true;
using (IOutlookApplication outlookApplication = GetOrCreateOutlookApplication()) {
if (outlookApplication != null) {
if (outlookApplication == null) {
return false;
}
if (outlookVersion.Major >= OUTLOOK_2013) {
// Check inline "panel" for Outlook 2013
using (var activeExplorer = outlookApplication.ActiveExplorer()) {
if (activeExplorer != null) {
if (activeExplorer == null) {
return false;
}
var currentCaption = activeExplorer.Caption;
if (currentCaption.StartsWith(inspectorCaption)) {
using (var inlineResponse = activeExplorer.ActiveInlineResponse) {
using (IItem currentItem = activeExplorer.ActiveInlineResponse) {
if (canExportToInspector(inlineResponse, allowMeetingAsTarget)) {
if (canExportToInspector(inlineResponse)) {
try {
return ExportToInspector(activeExplorer, currentItem, tmpFile, attachmentName);
} catch (Exception exExport) {
@ -169,17 +171,18 @@ namespace Greenshot.Interop.Office {
}
}
}
}
IInspectors inspectors = outlookApplication.Inspectors;
if (inspectors != null && inspectors.Count > 0) {
using (IInspectors inspectors = outlookApplication.Inspectors) {
if (inspectors == null || inspectors.Count == 0) {
return false;
}
LOG.DebugFormat("Got {0} inspectors to check", inspectors.Count);
for (int i = 1; i <= inspectors.Count; i++) {
using (IInspector inspector = outlookApplication.Inspectors[i]) {
string currentCaption = inspector.Caption;
if (currentCaption.StartsWith(inspectorCaption)) {
using (IItem currentItem = inspector.CurrentItem) {
if (canExportToInspector(currentItem, allowMeetingAsTarget)) {
if (canExportToInspector(currentItem)) {
try {
return ExportToInspector(inspector, currentItem, tmpFile, attachmentName);
} catch (Exception exExport) {
@ -192,7 +195,6 @@ namespace Greenshot.Interop.Office {
}
}
}
}
return false;
}
@ -252,12 +254,7 @@ namespace Greenshot.Interop.Office {
try {
if (WordExporter.InsertIntoExistingDocument(wordDocument.Application, wordDocument, tmpFile, null, null)) {
LOG.Info("Inserted into Wordmail");
// check the format afterwards, otherwise we lose the selection
//if (!OlBodyFormat.olFormatHTML.Equals(currentMail.BodyFormat)) {
// LOG.Info("Changing format to HTML.");
// currentMail.BodyFormat = OlBodyFormat.olFormatHTML;
//}
wordDocument.Dispose();
return true;
}
} catch (Exception exportException) {
@ -324,6 +321,7 @@ namespace Greenshot.Interop.Office {
IPropertyAccessor propertyAccessor = attachment.PropertyAccessor;
propertyAccessor.SetProperty(PropTag.ATTACHMENT_CONTENT_ID, contentID);
} catch {
// Ignore
}
}
}
@ -347,7 +345,7 @@ namespace Greenshot.Interop.Office {
/// <param name="tmpFile"></param>
/// <param name="captureDetails"></param>
private static void ExportToNewEmail(IOutlookApplication outlookApplication, EmailFormat format, string tmpFile, string subject, string attachmentName, string to, string CC, string BCC, string url) {
IItem newItem = outlookApplication.CreateItem(OlItemType.olMailItem);
using (IItem newItem = outlookApplication.CreateItem(OlItemType.olMailItem)) {
if (newItem == null) {
return;
}
@ -373,17 +371,19 @@ namespace Greenshot.Interop.Office {
}
switch (format) {
case EmailFormat.Text:
newMail.Attachments.Add(tmpFile, OlAttachmentType.olByValue, 1, attachmentName);
// Create the attachment (and dispose the COM object after using)
using (IAttachment attachment = newMail.Attachments.Add(tmpFile, OlAttachmentType.olByValue, 1, attachmentName)) {
newMail.BodyFormat = OlBodyFormat.olFormatPlain;
if (bodyString == null) {
bodyString = "";
}
newMail.Body = bodyString;
}
break;
case EmailFormat.HTML:
default:
string contentID = Path.GetFileName(tmpFile);
// Create the attachment
// Create the attachment (and dispose the COM object after using)
using (IAttachment attachment = newMail.Attachments.Add(tmpFile, OlAttachmentType.olByValue, 0, attachmentName)) {
// add content ID to the attachment
if (outlookVersion.Major >= OUTLOOK_2007) {
@ -427,10 +427,16 @@ namespace Greenshot.Interop.Office {
}
// So not save, otherwise the email is always stored in Draft folder.. (newMail.Save();)
newMail.Display(false);
newMail.GetInspector().Activate();
if (newItem != null) {
newItem.Dispose();
using (IInspector inspector = newMail.GetInspector()) {
if (inspector != null) {
try {
inspector.Activate();
} catch {
// Ignore
}
}
}
}
}

View file

@ -40,24 +40,32 @@ namespace Greenshot.Interop.Office {
/// Get the captions of all the open powerpoint presentations
/// </summary>
/// <returns></returns>
public static System.Collections.Generic.List<string> GetPowerpointPresentations() {
System.Collections.Generic.List<string> presentations = new System.Collections.Generic.List<string>();
public static List<string> GetPowerpointPresentations() {
List<string> foundPresentations = new System.Collections.Generic.List<string>();
try {
using (IPowerpointApplication powerpointApplication = COMWrapper.GetInstance<IPowerpointApplication>()) {
if (powerpointApplication != null) {
if (powerpointApplication == null) {
return foundPresentations;
}
if (version == null) {
version = powerpointApplication.Version;
}
LOG.DebugFormat("Open Presentations: {0}", powerpointApplication.Presentations.Count);
for (int i = 1; i <= powerpointApplication.Presentations.Count; i++) {
IPresentation presentation = powerpointApplication.Presentations.item(i);
if (presentation != null && presentation.ReadOnly != MsoTriState.msoTrue) {
using (IPresentations presentations = powerpointApplication.Presentations) {
LOG.DebugFormat("Open Presentations: {0}", presentations.Count);
for (int i = 1; i <= presentations.Count; i++) {
using (IPresentation presentation = presentations.item(i)) {
if (presentation == null) {
continue;
}
if (presentation.ReadOnly == MsoTriState.msoTrue) {
continue;
}
if (isAfter2003()) {
if (presentation.Final) {
continue;
}
}
presentations.Add(presentation.Name);
foundPresentations.Add(presentation.Name);
}
}
}
@ -66,7 +74,7 @@ namespace Greenshot.Interop.Office {
LOG.Warn("Problem retrieving word destinations, ignoring: ", ex);
}
return presentations;
return foundPresentations;
}
/// <summary>
@ -79,11 +87,19 @@ namespace Greenshot.Interop.Office {
/// <returns></returns>
public static bool ExportToPresentation(string presentationName, string tmpFile, Size imageSize, string title) {
using (IPowerpointApplication powerpointApplication = COMWrapper.GetInstance<IPowerpointApplication>()) {
if (powerpointApplication != null) {
LOG.DebugFormat("Open Presentations: {0}", powerpointApplication.Presentations.Count);
for (int i = 1; i <= powerpointApplication.Presentations.Count; i++) {
IPresentation presentation = powerpointApplication.Presentations.item(i);
if (presentation != null && presentation.Name.StartsWith(presentationName)) {
if (powerpointApplication == null) {
return false;
}
using (IPresentations presentations = powerpointApplication.Presentations) {
LOG.DebugFormat("Open Presentations: {0}", presentations.Count);
for (int i = 1; i <= presentations.Count; i++) {
using (IPresentation presentation = presentations.item(i)) {
if (presentation == null) {
continue;
}
if (!presentation.Name.StartsWith(presentationName)) {
continue;
}
try {
AddPictureToPresentation(presentation, tmpFile, imageSize, title);
return true;
@ -97,9 +113,17 @@ namespace Greenshot.Interop.Office {
return false;
}
/// <summary>
/// Internal method to add a picture to a presentation
/// </summary>
/// <param name="presentation"></param>
/// <param name="tmpFile"></param>
/// <param name="imageSize"></param>
/// <param name="title"></param>
private static void AddPictureToPresentation(IPresentation presentation, string tmpFile, Size imageSize, string title) {
if (presentation != null) {
//ISlide slide = presentation.Slides.AddSlide( presentation.Slides.Count + 1, PPSlideLayout.ppLayoutPictureWithCaption);
if (presentation == null) {
return;
}
ISlide slide;
float left = (presentation.PageSetup.SlideWidth / 2) - (imageSize.Width / 2) ;
float top = (presentation.PageSetup.SlideHeight / 2) - (imageSize.Height / 2);
@ -109,13 +133,15 @@ namespace Greenshot.Interop.Office {
IShape shapeForCaption = null;
bool hasScaledWidth = false;
bool hasScaledHeight = false;
// Try to create the slide
using (ISlides slides = presentation.Slides) {
try {
slide = presentation.Slides.Add(presentation.Slides.Count + 1, (int)PPSlideLayout.ppLayoutPictureWithCaption);
slide = slides.Add(slides.Count + 1, (int)PPSlideLayout.ppLayoutPictureWithCaption);
isLayoutPictureWithCaption = true;
// Shapes[2] is the image shape on this layout.
shapeForCaption = slide.Shapes.item(1);
IShape shapeForLocation = slide.Shapes.item(2);
using (IShape shapeForLocation = slide.Shapes.item(2)) {
if (width > shapeForLocation.Width) {
width = shapeForLocation.Width;
left = shapeForLocation.Left;
@ -133,11 +159,16 @@ namespace Greenshot.Interop.Office {
top = (shapeForLocation.Top + (shapeForLocation.Height / 2)) - (imageSize.Height / 2);
}
shapeForLocation.Height = imageSize.Height;
}
} catch (Exception e) {
LOG.Error(e);
slide = presentation.Slides.Add(presentation.Slides.Count + 1, (int)PPSlideLayout.ppLayoutBlank);
// didn't work. Use simple slide layout
slide = slides.Add(slides.Count + 1, (int)PPSlideLayout.ppLayoutBlank);
}
IShape shape = slide.Shapes.AddPicture(tmpFile, MsoTriState.msoFalse, MsoTriState.msoTrue, 0, 0, width, height);
}
// Make sure the picture is added and correctly scaled
using (IShape shape = slide.Shapes.AddPicture(tmpFile, MsoTriState.msoFalse, MsoTriState.msoTrue, 0, 0, width, height)) {
shape.LockAspectRatio = MsoTriState.msoTrue;
shape.ScaleHeight(1, MsoTriState.msoTrue, MsoScaleFrom.msoScaleFromMiddle);
shape.ScaleWidth(1, MsoTriState.msoTrue, MsoScaleFrom.msoScaleFromMiddle);
@ -150,35 +181,62 @@ namespace Greenshot.Interop.Office {
shape.Left = left;
shape.Top = top;
shape.AlternativeText = title;
if (isLayoutPictureWithCaption && shapeForCaption != null) {
}
// Try settings the caption
if (shapeForCaption != null) {
if (isLayoutPictureWithCaption) {
try {
// Using try/catch to make sure problems with the text range don't give an exception.
ITextFrame textFrame = shapeForCaption.TextFrame;
using (ITextFrame textFrame = shapeForCaption.TextFrame) {
textFrame.TextRange.Text = title;
}
} catch (Exception ex) {
LOG.Warn("Problem setting the title to a text-range", ex);
}
}
presentation.Application.ActiveWindow.View.GotoSlide(slide.SlideNumber);
presentation.Application.Activate();
shapeForCaption.Dispose();
}
// Show the window, and show the new slide
using (IPowerpointApplication application = presentation.Application) {
using (IPowerpointWindow activeWindow = application.ActiveWindow) {
using (IPowerpointView view = activeWindow.View) {
view.GotoSlide(slide.SlideNumber);
}
}
application.Activate();
}
if (slide != null) {
slide.Dispose();
}
}
/// <summary>
/// Insert a capture into a new presentation
/// </summary>
/// <param name="tmpFile"></param>
/// <param name="imageSize"></param>
/// <param name="title"></param>
/// <returns></returns>
public static bool InsertIntoNewPresentation(string tmpFile, Size imageSize, string title) {
bool isPictureAdded = false;
using (IPowerpointApplication powerpointApplication = COMWrapper.GetOrCreateInstance<IPowerpointApplication>()) {
if (powerpointApplication != null) {
if (powerpointApplication == null) {
return isPictureAdded;
}
powerpointApplication.Visible = true;
IPresentation presentation = powerpointApplication.Presentations.Add(MsoTriState.msoTrue);
using (IPresentations presentations = powerpointApplication.Presentations) {
using (IPresentation presentation = presentations.Add(MsoTriState.msoTrue)) {
try {
AddPictureToPresentation(presentation, tmpFile, imageSize, title);
isPictureAdded = true;
presentation.Application.Activate();
} catch (Exception e) {
LOG.Error(e);
}
}
}
}
return isPictureAdded;
}
}

View file

@ -555,7 +555,7 @@ namespace GreenshotPlugin.Core {
tmpFileCache.Remove(tmpfile);
}
return true;
} catch (Exception e) {
} catch (Exception) {
}
return false;
}

View file

@ -6,6 +6,6 @@ namespace Greenshot.Interop {
/// <summary>
/// Common properties that has appreared in almost all objects
/// </summary>
public interface Common : IDisposable {
public interface ICommon : IDisposable {
}
}