gnustep/libs-back
0
0
Fork 0
mirror of https://github.com/gnustep/libs-back.git synced 2025-02-24 12:21:34 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
libs-back/Source/win32/MSUserNotifications/MSUserNotification.mm
Marcian Lytwyn 58ca6b5c8e Add MSUserNotifications to Source/win32 directory to support notifications on windows 
git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/back/branches/gnustep_testplant_branch@39739 72102866-910b-0410-8b05-ffd578937521
2016-05-11 20:46:04 +00:00

633 lines
20 KiB
Text
Raw Blame History

/* Implementation for NSUserNotification for GNUstep/Windows
Copyright (C) 2014 Free Software Foundation, Inc.
Written by: Marcus Mueller <znek@mulle-kybernetik.com>
Date: 2014
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later version.
This library 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
Library General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free
Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02111 USA.
*/
// NOTE: for the time being, NSUserNotificationCenter needs this feature.
// Whenever this restriction is lifted, we can get rid of it here as well.
#if __has_feature(objc_default_synthesize_properties)
#define EXPOSE_NSUserNotification_IVARS 1
#define EXPOSE_NSUserNotificationCenter_IVARS 1
#import "MSUserNotification.h"
#import <GNUstepBase/GNUstep.h>
#import "GNUstepBase/NSObject+GNUstepBase.h"
#import "GNUstepBase/NSDebug+GNUstepBase.h"
#import <AppKit/NSGraphics.h>
#import <AppKit/NSImage.h>
#import <AppKit/NSWindow.h>
#import <Foundation/NSArray.h>
#import <Foundation/NSAutoreleasePool.h>
#import <Foundation/NSBundle.h>
#import <Foundation/NSDictionary.h>
#import "Foundation/NSException.h"
#import <Foundation/NSProcessInfo.h>
#import <Foundation/NSScanner.h>
#import <Foundation/NSString.h>
#import <Foundation/NSURL.h>
#import <Foundation/NSUUID.h>
#import <Foundation/NSValue.h>
#include <stdio.h>
#include <windows.h>
#include <ShellAPI.h>
#include <shlwapi.h>
#if defined(__cplusplus)
extern "C" {
#endif
static SendNotificationFunctionPtr pSendNotification = NULL;
static RemoveNotificationFunctionPtr pRemoveNotification = NULL;
static HMODULE hNotificationLib = NULL;
static NSString * const kButtonActionKey = @"show";
@interface NSImage (Private)
- (NSString*)_filename;
@end
@implementation NSImage (Private)
- (NSString*)_filename
{
return _fileName;
}
@end
@interface NSUserNotification ()
@property (readwrite, retain) NSDate *actualDeliveryDate;
@property (readwrite, getter=isPresented) BOOL presented;
@property (readwrite) NSUserNotificationActivationType activationType;
@end
@interface NSUserNotificationCenter (Private)
- (NSUserNotification *) deliveredNotificationWithUniqueId: (id)uniqueId;
@end
@interface MSUserNotificationCenter (Private)
- (NSString *) cleanupTextIfNecessary: (NSString *)rawText;
@end
@implementation MSUserNotificationCenter
- (id) init
{
NSDebugLLog(@"NSUserNotification", @"initializing...");
self = [super init];
if (self)
{
NS_DURING
{
// Initialize instance variables...
imageToIcon = [NSMutableDictionary new];
uniqueID = 1;
NSBundle *classBundle = [NSBundle bundleForClass: [self class]];
NSBundle *mainBundle = [NSBundle mainBundle];
NSDictionary *infoDict = [mainBundle infoDictionary];
NSString *imageName = [[infoDict objectForKey:@"CFBundleIconFiles"] objectAtIndex:0];
NSString *imageType = @"";
NSString *path = nil;
NSImage *image = [self _imageForBundleInfo:infoDict];
appIcon = [self _iconFromImage:image];
appIconPath = [image _filename];
NSLog(@"%s:bundle: %@ image: %@ icon: %p path: %@", __PRETTY_FUNCTION__, classBundle, image, appIcon, appIconPath);
if (appIcon == NULL)
{
NSLog(@"%s:unable to load icon for bundle: %@ GetLastError: %ld", __PRETTY_FUNCTION__, mainBundle, GetLastError());
}
OSVERSIONINFO osvi = { 0 };
WINBOOL bIsWindows81orLater = false;
ZeroMemory(&osvi, sizeof(OSVERSIONINFO));
osvi.dwOSVersionInfoSize = sizeof(OSVERSIONINFO);
if (GetVersionEx(&osvi)== 0)
{
NSLog(@"%s:failed getting OS version with error id: %ld", __PRETTY_FUNCTION__, GetLastError());
}
else
{
#if defined(DEBUG)
NSLog(@"%s:version number is: %d", __PRETTY_FUNCTION__, osvi.dwMajorVersion);
#endif
if (osvi.dwMajorVersion >= 6)
{
if (osvi.dwMinorVersion == 1)
{
bIsWindows81orLater = 0;
}
else
{
bIsWindows81orLater = 1;
}
if(bIsWindows81orLater)
path = [classBundle pathForResource: @"ToastNotifications-0" ofType: @"dll"];
else
path = [classBundle pathForResource: @"TaskbarNotifications-0" ofType: @"dll"];
// Try loading the corresponding DLL required for notifications...
hNotificationLib = LoadLibrary([path UTF8String]);
// For for not good conditions...
if (hNotificationLib == NULL)
{
NSLog(@"%s:DLL load error: %ld", __PRETTY_FUNCTION__, GetLastError());
}
else
{
pSendNotification = (SendNotificationFunctionPtr)GetProcAddress(hNotificationLib, "sendNotification");
pRemoveNotification = (RemoveNotificationFunctionPtr)GetProcAddress(hNotificationLib, "removeNotification");
#if 1 //defined(DEBUG)
NSLog(@"%s:DLL ptr: %p send notification ptr: %p remove ptr: %p", __PRETTY_FUNCTION__,
hNotificationLib, pSendNotification, pRemoveNotification);
#endif
}
}
}
}
NS_HANDLER
{
}
NS_ENDHANDLER
}
return self;
}
- (void) dealloc
{
// Cleanup any icons we generated...
NSEnumerator *iter = [imageToIcon objectEnumerator];
HICON icon = NULL;
while ((icon = (HICON)[[iter nextObject] pointerValue]) != NULL)
{
DestroyIcon(icon);
}
[imageToIcon release];
[super dealloc];
}
- (NSImage*) _imageForBundleInfo:(NSDictionary*)infoDict
{
NSImage *image = nil;
NSString *appIconFile = [infoDict objectForKey: @"NSIcon"];
if (appIconFile && ![appIconFile isEqual: @""])
{
image = [NSImage imageNamed: appIconFile];
}
// Try to look up the icns file.
appIconFile = [infoDict objectForKey: @"CFBundleIconFile"];
if (appIconFile && ![appIconFile isEqual: @""])
{
image = [NSImage imageNamed: appIconFile];
}
if (image == nil)
{
image = [NSImage imageNamed: @"GNUstep"];
}
else
{
/* Set the new image to be named 'NSApplicationIcon' ... to do that we
* must first check that any existing image of the same name has its
* name removed.
*/
[(NSImage*)[NSImage imageNamed: @"NSApplicationIcon"] setName: nil];
// We need to copy the image as we may have a proxy here
image = AUTORELEASE([image copy]);
[image setName: @"NSApplicationIcon"];
}
return image;
}
- (HICON) _iconFromRep: (NSBitmapImageRep*)rep
{
HICON result = NULL;
if (rep)
{
int w = [rep pixelsWide];
int h = [rep pixelsHigh];
// Create a windows bitmap from the image representation's bitmap...
if ((w > 0) && (h > 0))
{
BITMAP bm;
HDC hDC = GetDC(NULL);
HDC hMainDC = CreateCompatibleDC(hDC);
HDC hAndMaskDC = CreateCompatibleDC(hDC);
HDC hXorMaskDC = CreateCompatibleDC(hDC);
HBITMAP hAndMaskBitmap = NULL;
HBITMAP hXorMaskBitmap = NULL;
// Create the source bitmap...
HBITMAP hSourceBitmap = CreateBitmap(w, h, [rep numberOfPlanes], [rep bitsPerPixel], [rep bitmapData]);
// Get the dimensions of the source bitmap
GetObject(hSourceBitmap, sizeof(BITMAP), &bm);
// Create compatible bitmaps for the device context...
hAndMaskBitmap = CreateCompatibleBitmap(hDC, bm.bmWidth, bm.bmHeight);
hXorMaskBitmap = CreateCompatibleBitmap(hDC, bm.bmWidth, bm.bmHeight);
// Select the bitmaps to DC
HBITMAP hOldMainBitmap = (HBITMAP)SelectObject(hMainDC, hSourceBitmap);
HBITMAP hOldAndMaskBitmap = (HBITMAP)SelectObject(hAndMaskDC, hAndMaskBitmap);
HBITMAP hOldXorMaskBitmap = (HBITMAP)SelectObject(hXorMaskDC, hXorMaskBitmap);
/* On windows, to calculate the color for a pixel, first an AND is done
* with the background and the "and" bitmap, then an XOR with the "xor"
* bitmap. This means that when the data in the "and" bitmap is 0, the
* pixel will get the color as specified in the "xor" bitmap.
* However, if the data in the "and" bitmap is 1, the result will be the
* background XOR'ed with the value in the "xor" bitmap. In case the "xor"
* data is completely black (0x000000) the pixel will become transparent,
* in case it's white (0xffffff) the pixel will become the inverse of the
* background color.
*/
// Scan each pixel of the souce bitmap and create the masks
int y;
int *pixel = (int*)[rep bitmapData];
for(y = 0; y < bm.bmHeight; ++y)
{
int x;
for (x = 0; x < bm.bmWidth; ++x)
{
if (*pixel++ == 0x00000000)
{
SetPixel(hAndMaskDC, x, y, RGB(255, 255, 255));
SetPixel(hXorMaskDC, x, y, RGB(0, 0, 0));
}
else
{
SetPixel(hAndMaskDC, x, y, RGB(0, 0, 0));
SetPixel(hXorMaskDC, x, y, GetPixel(hMainDC, x, y));
}
}
}
// Reselect the old bitmap objects...
SelectObject(hMainDC, hOldMainBitmap);
SelectObject(hAndMaskDC, hOldAndMaskBitmap);
SelectObject(hXorMaskDC, hOldXorMaskBitmap);
// Create the cursor from the generated and/xor data...
ICONINFO iconinfo = { 0 };
iconinfo.fIcon = FALSE;
iconinfo.xHotspot = 0;
iconinfo.yHotspot = 0;
iconinfo.hbmMask = hAndMaskBitmap;
iconinfo.hbmColor = hXorMaskBitmap;
// Finally, try to create the cursor...
result = CreateIconIndirect(&iconinfo);
// Cleanup the DC's...
DeleteDC(hXorMaskDC);
DeleteDC(hAndMaskDC);
DeleteDC(hMainDC);
// Cleanup the bitmaps...
DeleteObject(hXorMaskBitmap);
DeleteObject(hAndMaskBitmap);
DeleteObject(hSourceBitmap);
// Release the screen HDC...
ReleaseDC(NULL,hDC);
}
}
return(result);
}
- (NSBitmapImageRep*) _getStandardBitmap:(NSImage *)image
{
NSBitmapImageRep *rep;
if (image == nil)
{
return nil;
}
rep = (NSBitmapImageRep *)[image bestRepresentationForDevice: nil];
if (!rep || ![rep respondsToSelector: @selector(samplesPerPixel)])
{
/* FIXME: We might create a blank cursor here? */
//NSLog(@"%s:could not convert cursor bitmap data for image: %@", __PRETTY_FUNCTION__, image);
return nil;
}
else
{
// Convert into something usable by the backend
return [rep _convertToFormatBitsPerSample: 8
samplesPerPixel: [rep hasAlpha] ? 4 : 3
hasAlpha: [rep hasAlpha]
isPlanar: NO
colorSpaceName: NSCalibratedRGBColorSpace
bitmapFormat: 0
bytesPerRow: 0
bitsPerPixel: 0];
}
}
- (HICON) _iconFromImage: (NSImage *)image
{
// Default the return cursur ID to NULL...
HICON result = NULL;
#if defined(DEBUG)
NSLog(@"%s:image: %@ imageToIcon dict: %@", __PRETTY_FUNCTION__, image, imageToIcon);
#endif
if ([image name] == nil)
{
NSLog(@"%s:cannot create/store image icon for NIL image names: %@", __PRETTY_FUNCTION__, result, [image name]);
}
else if ([imageToIcon objectForKey:[image name]])
{
result = (HICON)[[imageToIcon objectForKey: image] pointerValue];
#if defined(DEBUG)
NSLog(@"%s:reusing icon: %p for imageName: %@", __PRETTY_FUNCTION__, result, [image name]);
#endif
}
else
{
NSBitmapImageRep *rep = [self _getStandardBitmap:image];
if (rep == NULL)
{
NSLog(@"%s:error creating standard bitmap for image: %@", __PRETTY_FUNCTION__, image);
}
else
{
// Try to create the icon from the image...
result = [self _iconFromRep:rep];
// Need to save these created cursors to remove later...
if (result != NULL)
{
[imageToIcon setObject:[NSValue valueWithPointer:result] forKey:[image name]];
#if defined(DEBUG)
NSLog(@"%s:saving icon: %p for imageName: %@", __PRETTY_FUNCTION__, result, [image name]);
#endif
}
}
}
// Return whatever we were able to generate...
return(result);
}
- (GUID)guidFromUUIDString:(NSString*)uuidString
{
NSLog(@"%s:UUIDString: %@", __PRETTY_FUNCTION__, uuidString);
GUID theGUID = { 0 };
NSUInteger value = 0;
NSArray *components = [uuidString componentsSeparatedByString: @"-"];
NSScanner *scanner1 = [NSScanner scannerWithString: [components objectAtIndex: 0]];
NSScanner *scanner2 = [NSScanner scannerWithString: [components objectAtIndex: 1]];
NSScanner *scanner3 = [NSScanner scannerWithString: [components objectAtIndex: 2]];
NSString *data4 = [[components objectAtIndex: 3] stringByAppendingString: [components objectAtIndex: 4]];
NSScanner *scanner4 = [NSScanner scannerWithString: data4];
[scanner1 scanHexInt: (NSUInteger*)&theGUID.Data1];
[scanner2 scanHexInt: (NSUInteger*)&value];
theGUID.Data2 = (WORD) value;
[scanner3 scanHexInt: (NSUInteger*)&value];
theGUID.Data3 = (WORD) value;
return theGUID;
}
- (GUID)guidFromUUID:(NSUUID*)uuid
{
// Note: This is an example GUID only and should not be used.
// Normally, you should use a GUID-generating tool to provide the value to
// assign to guidItem.
return([self guidFromUUIDString:[uuid UUIDString]]);
}
- (NSUUID*)generateUUID
{
return [NSUUID UUID];
}
- (GUID)generateGUID
{
return [self guidFromUUID:[self generateUUID]];
}
- (NSNumber*)_showNotification:(NSUserNotification*)note forWindow:(NSWindow*)forWindow
{
NSAutoreleasePool *pool = [NSAutoreleasePool new];
#if defined(DEBUG)
NSLog(@"%s:title: %@ informativeText: %@ contentImage: %@ (%@)", __PRETTY_FUNCTION__, note.title, note.informativeText, note.contentImage, [note.contentImage _filename]);
#endif
NSNumber *result = nil;
if (pSendNotification != NULL)
{
NSUUID *uuid = [self generateUUID];
NSString *UUIDString = [uuid UUIDString];
std::string uuidString = std::string([UUIDString UTF8String]);
// Try to send the notification...
SEND_NOTE_INFO_T noteInfo = { 0 };
noteInfo.uuidString = [UUIDString UTF8String];
noteInfo.title = [note.title UTF8String];
noteInfo.informativeText = [note.informativeText UTF8String];
noteInfo.appIconPath = [appIconPath UTF8String];
// Content image is for displaying within the notification...
// i.e. Shell notes - within the balloon somwhere...
// Toast notes - with the toast window somewhere
// Check for content image and generate a windows icon from it...
if (note.contentImage != nil)
{
// Attempt to create a window icon from image...
noteInfo.contentIcon = [self _iconFromImage:note.contentImage];
#if defined(DEBUG)
NSLog(@"%s:image: %@ icon: %p", __PRETTY_FUNCTION__, note.contentImage, noteInfo.contentIcon);
#endif
}
BOOL status = pSendNotification((HWND)GetModuleHandle(NULL), appIcon, &noteInfo);
if (status)
{
note.identifier = [[UUIDString copy] autorelease];
note.presented = YES;
#if defined(DEBUG)
NSLog(@"%s:status: %d uniqueID: %d", __PRETTY_FUNCTION__, status, uniqueID);
#endif
return [NSNumber numberWithBool:uniqueID++];
}
}
// Cleanup...
[pool drain];
// TODO: Should we return something else here????
return [NSNumber numberWithBool:0];
}
- (void) _deliverNotification: (NSUserNotification *)un
{
NSAutoreleasePool *pool = [NSAutoreleasePool new];
NSString *appName = nil;
NSString *imageName = nil;
NSURL *imageURL = nil;
NSURL *soundFileURL = nil;
NSBundle *bundle = [NSBundle mainBundle];
if (bundle)
{
NSDictionary *info = [bundle localizedInfoDictionary];
if (info)
{
appName = [info objectForKey: @"NSBundleName"];
imageName = [info objectForKey: @"NSIcon"];
if (imageName)
imageURL = [bundle URLForResource: imageName withExtension: nil];
}
if (un.soundName && [caps containsObject:@"sound"])
{
soundFileURL = [bundle URLForResource: un.soundName
withExtension: nil];
}
}
// fallback
if (!appName)
appName = [[NSProcessInfo processInfo] processName];
NSMutableArray *actions = [NSMutableArray array];
#if 0
if ([un hasActionButton])
{
NSString *actionButtonTitle = un.actionButtonTitle;
if (!actionButtonTitle)
actionButtonTitle = _(@"Show");
// NOTE: don't use "default", as it's used by convention and seems
// to remove the actionButton entirely
// (tested with Notification Daemon (0.3.7))
[actions addObject: kButtonActionKey];
[actions addObject: [self cleanupTextIfNecessary: actionButtonTitle]];
}
#endif
NSDebugMLLog(@"NSUserNotification",
@"appName: %@ imageName: %@ imageURL: %@ soundFileURL: %@",
appName, imageName, imageURL, soundFileURL);
NSMutableDictionary *hints = [NSMutableDictionary dictionary];
if (un.userInfo)
[hints addEntriesFromDictionary: un.userInfo];
if (imageURL)
[hints setObject: [imageURL absoluteString] forKey: @"image-path"];
if (soundFileURL)
[hints setObject: [soundFileURL path] forKey: @"sound-file"];
NSString *summary = [self cleanupTextIfNecessary: un.title];
NSString *body = [self cleanupTextIfNecessary: un.informativeText];
NSNumber *uniqueId = [self _showNotification:un forWindow: nil];
ASSIGN(un->_uniqueId, uniqueId);
un.presented = ([uniqueId integerValue] != 0) ? YES : NO;
[pool drain];
}
- (void)_removeDeliveredNotification:(NSUserNotification *)theNote
{
#if defined(DEBUG)
NSLog(@"%s:note: %@ ID: %@", __PRETTY_FUNCTION__, theNote, theNote->_uniqueId);
#endif
if (pRemoveNotification != NULL)
{
REMOVE_NOTE_INFO_T noteInfo = { 0 };
noteInfo.uniqueID = [theNote->_uniqueId integerValue];
pRemoveNotification(appIcon, &noteInfo);
}
}
- (NSString *)cleanupTextIfNecessary:(NSString *)rawText
{
if (!rawText || ![caps containsObject:@"body-markup"])
return nil;
NSMutableString *t = (NSMutableString *)[rawText mutableCopy];
[t replaceOccurrencesOfString: @"&" withString: @"&amp;" options: 0 range: NSMakeRange(0, [t length])]; // must be first!
[t replaceOccurrencesOfString: @"<" withString: @"&lt;" options: 0 range: NSMakeRange(0, [t length])];
[t replaceOccurrencesOfString: @">" withString: @"&gt;" options: 0 range: NSMakeRange(0, [t length])];
[t replaceOccurrencesOfString: @"\"" withString: @"&quot;" options: 0 range: NSMakeRange(0, [t length])];
[t replaceOccurrencesOfString: @"'" withString: @"&apos;" options: 0 range: NSMakeRange(0, [t length])];
return t;
}
// SIGNALS
- (void)receiveNotificationClosedNotification:(NSNotification *)n
{
id nId = [[n userInfo] objectForKey: @"arg0"];
NSUserNotification *un = [self deliveredNotificationWithUniqueId: nId];
NSDebugMLLog(@"NSUserNotification", @"%@", un);
}
- (void)receiveActionInvokedNotification:(NSNotification *)n
{
id nId = [[n userInfo] objectForKey: @"arg0"];
NSUserNotification *un = [self deliveredNotificationWithUniqueId: nId];
NSString *action = [[n userInfo] objectForKey: @"arg1"];
NSDebugMLLog(@"NSUserNotification", @"%@ -- action: %@", un, action);
if ([action isEqual:kButtonActionKey])
un.activationType = NSUserNotificationActivationTypeActionButtonClicked;
else
un.activationType = NSUserNotificationActivationTypeContentsClicked;
if (self.delegate && [self.delegate respondsToSelector:@selector(userNotificationCenter:didActivateNotification:)])
[self.delegate userNotificationCenter: self didActivateNotification: un];
}
@end
#if defined(__cplusplus)
}
#endif
#endif /* __has_feature(objc_default_synthesize_properties) */
Reference in a new issue View git blame Copy permalink