From 4046ab3473eb7d80d1e5cced4c8ac7fc38f7fdf3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sebasti=C3=A1n=20Katzer?= Date: Mon, 21 Jan 2019 15:17:07 +0100 Subject: [PATCH] Update ios code for version 0.8 --- plugin.xml | 17 +- src/ios/APPPrinter.h | 8 +- src/ios/APPPrinter.m | 592 ++++++++++++++++++------------------- src/ios/APPPrinterInfo.h | 26 ++ src/ios/APPPrinterInfo.m | 80 +++++ src/ios/APPPrinterItem.h | 28 ++ src/ios/APPPrinterItem.m | 200 +++++++++++++ src/ios/APPPrinterLayout.h | 35 +++ src/ios/APPPrinterLayout.m | 101 +++++++ src/ios/APPPrinterPaper.h | 33 +++ src/ios/APPPrinterPaper.m | 82 +++++ www/printer.js | 33 ++- 12 files changed, 924 insertions(+), 311 deletions(-) create mode 100644 src/ios/APPPrinterInfo.h create mode 100644 src/ios/APPPrinterInfo.m create mode 100644 src/ios/APPPrinterItem.h create mode 100644 src/ios/APPPrinterItem.m create mode 100644 src/ios/APPPrinterLayout.h create mode 100644 src/ios/APPPrinterLayout.m create mode 100644 src/ios/APPPrinterPaper.h create mode 100644 src/ios/APPPrinterPaper.m diff --git a/plugin.xml b/plugin.xml index 3339e98..670773c 100644 --- a/plugin.xml +++ b/plugin.xml @@ -26,11 +26,11 @@ + version="0.8.0.beta"> Printer - Prints HTML documents + Prints HTML content https://github.com/katzer/cordova-plugin-printer.git @@ -49,7 +49,6 @@ - @@ -64,6 +63,18 @@ + + + + + + + + + + + + diff --git a/src/ios/APPPrinter.h b/src/ios/APPPrinter.h index 245d968..efcee0d 100755 --- a/src/ios/APPPrinter.h +++ b/src/ios/APPPrinter.h @@ -21,13 +21,13 @@ #import -@interface APPPrinter : CDVPlugin +@interface APPPrinter : CDVPlugin // Find out whether printing is supported on this platform -- (void) check:(CDVInvokedUrlCommand*)command; +- (void) check:(CDVInvokedUrlCommand *)command; // Displays system interface for selecting a printer -- (void) pick:(CDVInvokedUrlCommand*)command; +- (void) pick:(CDVInvokedUrlCommand *)command; // Prints the content -- (void) print:(CDVInvokedUrlCommand*)command; +- (void) print:(CDVInvokedUrlCommand *)command; @end diff --git a/src/ios/APPPrinter.m b/src/ios/APPPrinter.m index c86fc9b..ecfbe9b 100755 --- a/src/ios/APPPrinter.m +++ b/src/ios/APPPrinter.m @@ -1,5 +1,5 @@ /* - Copyright 2013-2016 appPlant GmbH + Copyright 2013 appPlant GmbH Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file @@ -20,18 +20,18 @@ */ #import "APPPrinter.h" -#import +#import "APPPrinterItem.h" +#import "APPPrinterInfo.h" +#import "APPPrinterPaper.h" +#import "APPPrinterLayout.h" @interface APPPrinter () -@property (retain) NSString* callbackId; -@property (retain) NSMutableDictionary* settings; -// this is used to cache the uiprinter making repeated prints faster +@property (retain) NSDictionary* settings; @property (nonatomic) UIPrinter *previousPrinter; @end - @implementation APPPrinter #pragma mark - @@ -40,87 +40,52 @@ /* * Checks if the printing service is available. */ -- (void) check:(CDVInvokedUrlCommand*)command +- (void) check:(CDVInvokedUrlCommand *)command { [self.commandDelegate runInBackground:^{ - CDVPluginResult* pluginResult; - BOOL isAvailable = [self isPrintingAvailable]; - NSArray *multipart = @[[NSNumber numberWithBool:isAvailable], - [NSNumber numberWithInt:-1]]; + BOOL res = NO; - pluginResult = [CDVPluginResult resultWithStatus:CDVCommandStatus_OK - messageAsMultipart:multipart]; + if (command.arguments.count == 0) + { + res = UIPrintInteractionController.isPrintingAvailable; + } + else + { + res = [APPPrinterItem canPrintURL:command.arguments[0]]; + } - [self.commandDelegate sendPluginResult:pluginResult - callbackId:command.callbackId]; + [self sendResultWithMessageAsBool:res + callbackId:command.callbackId]; + }]; +} + +/** + * Displays system interface for selecting a printer. + */ +- (void) pick:(CDVInvokedUrlCommand *)command +{ + [self.commandDelegate runInBackground:^{ + NSMutableDictionary* settings = command.arguments[0]; + settings[@"callbackId"] = command.callbackId; + + [self presentPickerWithSettings:settings]; }]; } /** * Sends the printing content to the printer controller and opens them. */ -- (void) print:(CDVInvokedUrlCommand*)command +- (void) print:(CDVInvokedUrlCommand *)command { - if (!self.isPrintingAvailable) return; + [self.commandDelegate runInBackground:^{ + NSString* content = command.arguments[0]; + NSMutableDictionary* settings = command.arguments[1]; + settings[@"callbackId"] = command.callbackId; - UIPrintInteractionController* controller = [self printController]; - NSString* content = command.arguments[0]; + self.settings = settings; - _settings = command.arguments[1]; - _callbackId = command.callbackId; - - [self adjustPrintController:controller - withSettings:_settings]; - - [self loadContent:content intoPrintController:controller]; -} - -/** - * Displays system interface for selecting a printer. - */ -- (void) pick:(CDVInvokedUrlCommand*)command -{ - if (!self.isPrintingAvailable) return; - - NSMutableDictionary* settings = command.arguments[0]; - NSArray* bounds = settings[@"bounds"]; - _callbackId = command.callbackId; - CGRect rect; - - if (bounds) { - rect = [self convertIntoRect:bounds]; - } else { - rect = CGRectMake(40, 30, 0, 0); - } - - [self presentPrinterPicker:rect]; -} - -#pragma mark - -#pragma mark UIWebViewDelegate - -/** - * Sent after a web view finishes loading a frame. - * - * @param webView The web view has finished loading. - * - * @return [ Void ] - */ -- (void) webViewDidFinishLoad:(UIWebView *)webView -{ - UIPrintInteractionController* controller = [self printController]; - NSString* printerID = _settings[@"printerId"]; - - if (![printerID isEqual:[NSNull null]] && printerID.length > 0) - { - [self sendToPrinter:controller printer:printerID]; - return; - } - - NSArray* bounds = self.settings[@"bounds"]; - CGRect rect = [self convertIntoRect:bounds]; - - [self presentPrintController:controller fromRect:rect]; + [self printContent:content withSettings:settings]; + }]; } #pragma mark - @@ -131,25 +96,13 @@ * area to use for the print job. If Paper-Size is given it selects the best * fitting papersize */ -- (UIPrintPaper *) printInteractionController:(UIPrintInteractionController *)printInteractionController +- (UIPrintPaper *) printInteractionController:(UIPrintInteractionController *)ctrl choosePaper:(NSArray *)paperList { - double height = [self.settings[@"paperHeight"] doubleValue]; - double width = [self.settings[@"paperWidth"] doubleValue]; - UIPrintPaper* paper; + APPPrinterPaper* paperSpec = [[APPPrinterPaper alloc] + initWithDictionary:_settings[@"paper"]]; - if (height && width) - { - double dotsHeigth = 72 * height / 25.4; //convert milimeters to dots - double dotsWidth = 72 * width / 25.4; //convert milimeters to dots - CGSize pageSize = CGSizeMake(dotsHeigth, dotsWidth); - - // get best fitting paper size - paper = [UIPrintPaper bestPaperForPageSize:pageSize - withPapersFromArray:paperList]; - } - - return paper; + return [paperSpec bestPaperFromArray:paperList]; } /** @@ -157,264 +110,226 @@ * printers like Label-Printer (brother QL-710W) you can cut paper after given * length. */ -- (CGFloat) printInteractionController:(UIPrintInteractionController *)printInteractionController +- (CGFloat) printInteractionController:(UIPrintInteractionController *)ctrl cutLengthForPaper:(UIPrintPaper *)paper { - double length = [self.settings[@"paperCutLength"] doubleValue]; - CGFloat height = paper.paperSize.height; + APPPrinterPaper* paperSpec = [[APPPrinterPaper alloc] + initWithDictionary:_settings[@"paper"]]; - if (length) - { - height = 72 * length / 25.4; //convert milimeters to dots - } - - return height; + return paperSpec.length || paper.paperSize.height; } #pragma mark - #pragma mark Core -/** - * Checks either the printing service is avaible or not. - */ -- (BOOL) isPrintingAvailable -{ - Class controllerCls = NSClassFromString(@"UIPrintInteractionController"); - - if (!controllerCls) { - return NO; - } - - return [self printController] && [UIPrintInteractionController - isPrintingAvailable]; -} - -/** - * Sends the content directly to the specified or previously selected printer. - * - * @param controller The prepared print controller with the content. - * @param printer The printer specified by its URL. - * - * @return [ Void ] - */ -- (void) sendToPrinter:(UIPrintInteractionController*)controller - printer:(NSString*)printerID -{ - NSURL* printerURL = [NSURL URLWithString:printerID]; - - // check to see if we have previously created this printer to reduce printing/"contacting" time - if (!_previousPrinter || ![_previousPrinter.URL.absoluteString isEqualToString:printerID]) - { - _previousPrinter = [UIPrinter printerWithURL:printerURL]; - } - - [controller printToPrinter:_previousPrinter completionHandler: - ^(UIPrintInteractionController *ctrl, BOOL ok, NSError *e) { - CDVPluginResult* result = - [CDVPluginResult resultWithStatus:CDVCommandStatus_OK - messageAsBool:ok]; - - [self.commandDelegate sendPluginResult:result - callbackId:self->_callbackId]; - }]; -} - -/** - * Opens the print controller so that the user can choose between - * available iPrinters. - * - * @param controller The prepared print preview controller. - * @param rect The coordinates where to present the preview. - * - * @return [ Void ] - */ -- (void) presentPrintController:(UIPrintInteractionController*)controller - fromRect:(CGRect)rect -{ - UIPrintInteractionCompletionHandler handler = - ^(UIPrintInteractionController *ctrl, BOOL ok, NSError *e) { - CDVPluginResult* result = - [CDVPluginResult resultWithStatus:CDVCommandStatus_OK - messageAsBool:ok]; - - [self.commandDelegate sendPluginResult:result - callbackId:self.callbackId]; - }; - - if (UI_USER_INTERFACE_IDIOM() == UIUserInterfaceIdiomPad) { - [controller presentFromRect:rect - inView:self.webView - animated:YES - completionHandler:handler]; - } else { - [controller presentAnimated:YES - completionHandler:handler]; - } -} - /** * Displays system interface for selecting a printer. * - * @param rect Defines where to display the interface on the screen. + * @param settings Describes additional settings like from where to present the + * picker for iPad. * * @return [ Void ] */ -- (void) presentPrinterPicker:(CGRect)rect +- (void) presentPickerWithSettings:(NSDictionary *)settings { UIPrinterPickerController* controller = [UIPrinterPickerController printerPickerControllerWithInitiallySelectedPrinter:nil]; UIPrinterPickerCompletionHandler handler = ^(UIPrinterPickerController *ctrl, BOOL selected, NSError *e) { - [self returnPrinterPickerResult:ctrl]; + [self returnPickerResultForController:ctrl + callbackId:settings[@"callbackId"]]; }; - if (UI_USER_INTERFACE_IDIOM() == UIUserInterfaceIdiomPad) { - [controller presentFromRect:rect - inView:self.webView - animated:YES - completionHandler:handler]; - } else { - [controller presentAnimated:YES - completionHandler:handler]; - } -} + dispatch_async(dispatch_get_main_queue(), ^{ + if (UI_USER_INTERFACE_IDIOM() == UIUserInterfaceIdiomPad) { + NSArray* bounds = settings[@"ui"][@"bounds"]; + CGRect rect = [self convertIntoRect:bounds]; -/** - * Calls the callback funtion with the result of the selected printer. - * - * @param controller The UIPrinterPickerController used to display - * the printer selector interface. - * - * @return [ Void ] - */ -- (void) returnPrinterPickerResult:(UIPrinterPickerController*)controller -{ - CDVPluginResult* result; - UIPrinter* printer = controller.selectedPrinter; - - [self rememberPrinter:printer]; - - if (printer) { - result = [CDVPluginResult resultWithStatus:CDVCommandStatus_OK - messageAsString:printer.URL.absoluteString]; - } else { - result = [CDVPluginResult resultWithStatus:CDVCommandStatus_NO_RESULT]; - } - - [self.commandDelegate sendPluginResult:result - callbackId:_callbackId]; -} - -#pragma mark - -#pragma mark Helper - -/** - * Returns the shared instance of the printer controller. - */ -- (UIPrintInteractionController*) printController -{ - UIPrintInteractionController* controller = [UIPrintInteractionController - sharedPrintController]; - - controller.delegate = self; - - return controller; + [controller presentFromRect:rect + inView:self.webView + animated:YES + completionHandler:handler]; + } else { + [controller presentAnimated:YES + completionHandler:handler]; + } + }); } /** * Adjusts the settings for the print controller. * - * @param controller The print controller instance. - * @param settings The print job specs. + * @param view The view which content to print. + * @param settings The print job specs. * - * @return The modified print controller instance + * @return A ready to use print controller instance. */ -- (UIPrintInteractionController*) adjustPrintController:(UIPrintInteractionController*)controller - withSettings:(NSMutableDictionary*)settings +- (UIPrintInteractionController *) prepareControllerWithSettings:(NSDictionary *)settings { - UIPrintInfo* printInfo = [UIPrintInfo printInfo]; - UIPrintInfoOrientation orientation = UIPrintInfoOrientationPortrait; - UIPrintInfoOutputType outputType = UIPrintInfoOutputGeneral; - UIPrintInfoDuplex duplexMode = UIPrintInfoDuplexNone; - long copies = MAX([settings[@"copies"] longValue], 1); + UIPrintInfo* printInfo = [APPPrinterInfo printInfoWithDictionary:settings]; + NSDictionary* ui = settings[@"ui"]; - if ([settings[@"landscape"] boolValue]) { - orientation = UIPrintInfoOrientationLandscape; + UIPrintInteractionController* ctrl = + [UIPrintInteractionController sharedPrintController]; + + ctrl.printInfo = printInfo; + ctrl.delegate = self; + + if (ui) + { + ctrl.showsNumberOfCopies = ![ui[@"hideNumberOfCopies"] boolValue]; + ctrl.showsPaperSelectionForLoadedPapers = ![ui[@"hidePaperFormat"] boolValue]; } - if ([settings[@"graystyle"] boolValue]) { - outputType = UIPrintInfoOutputGrayscale; - } - - outputType += [settings[@"border"] boolValue] ? 0 : 1; - - if ([settings[@"duplex"] isEqualToString:@"long"]) { - duplexMode = UIPrintInfoDuplexLongEdge; - } else - if ([settings[@"duplex"] isEqualToString:@"short"]) { - duplexMode = UIPrintInfoDuplexShortEdge; - } - - [printInfo setValue:[NSNumber numberWithLong:copies] forKey:@"_copies"]; - - printInfo.outputType = outputType; - printInfo.orientation = orientation; - printInfo.duplex = duplexMode; - printInfo.jobName = settings[@"name"]; - controller.printInfo = printInfo; - - controller.showsNumberOfCopies = ![settings[@"hideNumberOfCopies"] boolValue]; - controller.showsPaperSelectionForLoadedPapers = ![settings[@"hidePaperFormat"] boolValue]; - - return controller; + return ctrl; } /** * Loads the content into the print controller. * - * @param content The (HTML encoded) content - * @param controller The print controller instance + * @param content The HTML content or remote web page URI to print. + * @param settings The print job specs. * * @return [ Void ] */ -- (void) loadContent:(NSString*)content intoPrintController:(UIPrintInteractionController*)controller +- (void) printContent:(NSString *)content + withSettings:(NSDictionary *)settings { - UIPrintPageRenderer* renderer = [[UIPrintPageRenderer alloc] init]; - UIViewPrintFormatter* formatter = self.webView.viewPrintFormatter; - bool printSelf = ![content isEqual:[NSNull null]] && content.length == 0; + __block id item; - if (!printSelf) + UIPrintInteractionController* ctrl = + [self prepareControllerWithSettings:settings]; + + if ([self strIsNullOrEmpty:content]) { - UIWebView* page = [[UIWebView alloc] init]; - formatter = page.viewPrintFormatter; + dispatch_sync(dispatch_get_main_queue(), ^{ + item = self.webView.viewPrintFormatter; + }); + } + else if ([content characterAtIndex:0] == '<') + { + dispatch_sync(dispatch_get_main_queue(), ^{ + item = [[UIMarkupTextPrintFormatter alloc] + initWithMarkupText:content]; + }); + } + else if ([NSURL URLWithString:content]) + { + item = [APPPrinterItem ItemFromURL:content]; + } + else + { + dispatch_sync(dispatch_get_main_queue(), ^{ + item = [[UISimpleTextPrintFormatter alloc] + initWithText:content]; + }); + } - page.delegate = self; + [self useController:ctrl toPrintItem:item withSettings:settings]; +} - if ([NSURL URLWithString:content]) +/** + * Print the rendered content of the given view. + * + * @param ctrl The interactive printer controller. + * @param item Either the item to print or the formatted content. + * @param settings The print job specs. + * + * @return [ Void ] + */ +- (void) useController:(UIPrintInteractionController *)ctrl + toPrintItem:(id)item + withSettings:(NSDictionary *)settings +{ + NSString* printer = settings[@"printerId"]; + + if ([item isKindOfClass:UIPrintFormatter.class]) + { + ctrl.printFormatter = + [APPPrinterLayout configureFormatter:item + withLayoutFromDictionary:settings[@"layout"]]; + } + else + { + ctrl.printingItem = item; + } + + if ([self strIsNullOrEmpty:printer]) + { + [self presentController:ctrl withSettings:settings]; + } + else + { + [self printToPrinter:ctrl withSettings:settings]; + } +} + +/** + * Sends the content directly to the specified or previously selected printer. + * + * @param ctrl The interactive printer controller. + * @param printerURL The printer specified by its URL. + * @param settings The print job specs. + * + * @return [ Void ] + */ +- (void) printToPrinter:(UIPrintInteractionController *)ctrl + withSettings:(NSDictionary *)settings +{ + NSString* callbackId = settings[@"callbackId"]; + NSString* printerURL = settings[@"printerId"]; + UIPrinter* printer = [self printerWithURL:printerURL]; + + dispatch_async(dispatch_get_main_queue(), ^{ + [ctrl printToPrinter:printer completionHandler: + ^(UIPrintInteractionController *ctrl, BOOL ok, NSError *e) { + [self rememberPrinter:(ok ? printer : NULL)]; + [self sendResultWithMessageAsBool:ok callbackId:callbackId]; + }]; + }); +} + +/** + * Opens the print controller so that the user can choose between + * available iPrinters. + * + * @param ctrl The interactive printer controller. + * @param settings The print job specs. + * + * @return [ Void ] + */ +- (void) presentController:(UIPrintInteractionController *)ctrl + withSettings:(NSDictionary *)settings +{ + NSString* callbackId = settings[@"callbackId"]; + NSArray* bounds = settings[@"ui"][@"bounds"]; + CGRect rect = [self convertIntoRect:bounds]; + + UIPrintInteractionCompletionHandler handler = + ^(UIPrintInteractionController *ctrl, BOOL ok, NSError *e) { + [self sendResultWithMessageAsBool:ok callbackId:callbackId]; + }; + + dispatch_async(dispatch_get_main_queue(), ^{ + if (UI_USER_INTERFACE_IDIOM() == UIUserInterfaceIdiomPad) { - NSURL *url = [NSURL URLWithString:content]; - - [page loadRequest:[NSURLRequest requestWithURL:url]]; + [ctrl presentFromRect:rect + inView:self.webView + animated:YES + completionHandler:handler]; } else { - NSString* path = [NSBundle.mainBundle pathForResource:@"www" ofType:nil]; - NSURL *url = [NSURL fileURLWithPath:path]; - - [page loadHTMLString:content baseURL:url]; + [ctrl presentAnimated:YES + completionHandler:handler]; } - } - - [renderer addPrintFormatter:formatter startingAtPageAtIndex:0]; - [controller setPrintPageRenderer:renderer]; - - if (printSelf) { - // just trigger the finish load fn straight off if using current webView - [self webViewDidFinishLoad:(UIWebView *)self.webView]; - } + }); } +#pragma mark - +#pragma mark Helper + /** * Tells the system to pre-select the given printer next time. * @@ -424,8 +339,32 @@ */ - (void) rememberPrinter:(UIPrinter*)printer { - if (!printer) return; - [UIPrinterPickerController printerPickerControllerWithInitiallySelectedPrinter:printer]; + [UIPrinterPickerController + printerPickerControllerWithInitiallySelectedPrinter:(_previousPrinter = printer)]; +} + +/** + * Returns an object that can be used to connect to the network printer. + * + * @param url The network URL as a string. + * + * @return A printer even if the URL is not a valid printer. + */ +- (UIPrinter *)printerWithURL:(NSString *)urlAsString +{ + NSURL* url = [NSURL URLWithString:urlAsString]; + UIPrinter* printer; + + if (_previousPrinter && [_previousPrinter.URL.absoluteString isEqualToString:urlAsString]) + { + printer = _previousPrinter; + } + else + { + printer = [UIPrinter printerWithURL:url]; + } + + return printer; } /** @@ -437,11 +376,72 @@ */ - (CGRect) convertIntoRect:(NSArray*)bounds { + if (!bounds) { + bounds = @[@40, @30, @0, @0]; + } + return CGRectMake([bounds[0] floatValue], [bounds[1] floatValue], [bounds[2] floatValue], [bounds[3] floatValue]); } +/** + * Test if the given string is null or empty. + * + * @param string The string to test. + * + * @return true or false + */ +- (BOOL) strIsNullOrEmpty:(NSString *)string +{ + return [string isEqual:[NSNull null]] || string.length == 0; +} + +/** + * Calls the callback funtion with the result of the selected printer. + * + * @param ctrl The controller used to display the printer selector interface. + * @param callbackId The ID of the callback that shall receive the info. + * + * @return [ Void ] + */ +- (void) returnPickerResultForController:(UIPrinterPickerController *)ctrl + callbackId:(NSString *)callbackId +{ + UIPrinter* printer = ctrl.selectedPrinter; + CDVPluginResult* result; + + [self rememberPrinter:printer]; + + if (printer) { + result = [CDVPluginResult resultWithStatus:CDVCommandStatus_OK + messageAsString:printer.URL.absoluteString]; + } else { + result = [CDVPluginResult resultWithStatus:CDVCommandStatus_NO_RESULT]; + } + + [self.commandDelegate sendPluginResult:result + callbackId:callbackId]; +} + +/** + * Sends the plugin result by invoking the callback function with a boolean arg. + * + * @param msg The boolean message value. + * + * @return [ Void ] + */ +- (void) sendResultWithMessageAsBool:(BOOL)msg + callbackId:(NSString *)callbackId +{ + CDVPluginResult* result = + [CDVPluginResult resultWithStatus:CDVCommandStatus_OK + messageAsBool:msg]; + + [self.commandDelegate sendPluginResult:result + callbackId:callbackId]; +} + @end diff --git a/src/ios/APPPrinterInfo.h b/src/ios/APPPrinterInfo.h new file mode 100644 index 0000000..0be20b7 --- /dev/null +++ b/src/ios/APPPrinterInfo.h @@ -0,0 +1,26 @@ +/* + Copyright 2013 appPlant GmbH + + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. + */ + +@interface APPPrinterInfo : UIPrintInfo + ++ (UIPrintInfo *) printInfoWithDictionary:(NSDictionary *)spec; + +@end diff --git a/src/ios/APPPrinterInfo.m b/src/ios/APPPrinterInfo.m new file mode 100644 index 0000000..3744f06 --- /dev/null +++ b/src/ios/APPPrinterInfo.m @@ -0,0 +1,80 @@ +/* + Copyright 2013 appPlant GmbH + + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. + */ + +#import "APPPrinterInfo.h" + +@implementation APPPrinterInfo + +#pragma mark - +#pragma mark Init + ++ (UIPrintInfo *) printInfoWithDictionary:(NSDictionary *)spec +{ + UIPrintInfo* info = [APPPrinterInfo printInfo]; + NSString* duplex = spec[@"duplex"]; + NSString* jobName = spec[@"name"]; + long copies = MAX([spec[@"copies"] longValue], 1); + + if ([spec[@"landscape"] boolValue]) + { + info.orientation = UIPrintInfoOrientationLandscape; + } + + if ([spec[@"graystyle"] boolValue]) + { + if ([spec[@"photo"] boolValue]) + { + info.outputType = UIPrintInfoOutputPhotoGrayscale; + } + else + { + info.outputType = UIPrintInfoOutputGrayscale; + } + } + else if ([spec[@"photo"] boolValue]) + { + info.outputType = UIPrintInfoOutputPhoto; + } + + if ([duplex isEqualToString:@"long"]) + { + info.duplex = UIPrintInfoDuplexLongEdge; + } + else if ([duplex isEqualToString:@"short"]) + { + info.duplex = UIPrintInfoDuplexShortEdge; + } + else if ([duplex isEqualToString:@"none"]) + { + info.duplex = UIPrintInfoDuplexNone; + } + + [info setValue:[NSNumber numberWithLong:copies] forKey:@"_copies"]; + + if (jobName) + { + info.jobName = jobName; + } + + return info; +} + +@end diff --git a/src/ios/APPPrinterItem.h b/src/ios/APPPrinterItem.h new file mode 100644 index 0000000..115ece8 --- /dev/null +++ b/src/ios/APPPrinterItem.h @@ -0,0 +1,28 @@ +/* + Copyright 2013 appPlant GmbH + + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. + */ + +@interface APPPrinterItem : NSObject + ++ (id) ItemFromURL:(NSString *)url; + ++ (BOOL) canPrintURL:(NSString *)url; + +@end diff --git a/src/ios/APPPrinterItem.m b/src/ios/APPPrinterItem.m new file mode 100644 index 0000000..60ad14d --- /dev/null +++ b/src/ios/APPPrinterItem.m @@ -0,0 +1,200 @@ +/* + Copyright 2013 appPlant GmbH + + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. + */ + +#import "APPPrinterItem.h" + +@implementation APPPrinterItem + +#pragma mark - +#pragma mark Public + +/** + * Returns the printing item refered by url either as NSURL or NSData. + * + * @param url Any kind of URL like file://, file:///, res:// or base64:// + * + * @return [ id ] NSURL or NSData + */ ++ (id) ItemFromURL:(NSString *)url +{ + return [[[APPPrinterItem alloc] init] itemFromURL:url]; +} + +/** + * Returns if the print framework is able to render the referenced file. + * + * @param url Any kind of URL like file://, file:///, res:// or base64:// + * + * @return true if its able to render the content of the file. + */ ++ (BOOL) canPrintURL:(NSString *)url +{ + if (![NSURL URLWithString:url]) return YES; + + id item = [self ItemFromURL:url]; + + if ([item isKindOfClass:NSData.class]) + { + return [UIPrintInteractionController canPrintData:item]; + } + else + { + return [UIPrintInteractionController canPrintURL:item]; + } +} + +#pragma mark - +#pragma mark Private + +/** + * Returns the printing item refered by url either as NSURL or NSData. + * + * @param url Any kind of URL like file://, file:///, res:// or base64:// + * + * @return [ id ] NSURL or NSData + */ +- (id) itemFromURL:(NSString *)path +{ + if ([path hasPrefix:@"file:///"]) + { + return [self urlForFile:path]; + } + else if ([path hasPrefix:@"res:"]) + { + return [self urlForResource:path]; + } + else if ([path hasPrefix:@"file://"]) + { + return [self urlForAsset:path]; + } + else if ([path hasPrefix:@"base64:"]) + { + return [self dataFromBase64:path]; + } + + NSFileManager* fm = [NSFileManager defaultManager]; + + if (![fm fileExistsAtPath:path]){ + NSLog(@"File not found: %@", path); + } + + return [NSURL fileURLWithPath:path]; +} + +/** + * URL to an absolute file path. + * + * @param [ NSString* ] path An absolute file path. + * + * @return [ NSURL* ] + */ +- (NSURL *) urlForFile:(NSString *)path +{ + NSFileManager* fm = [NSFileManager defaultManager]; + + NSString* absPath; + absPath = [path stringByReplacingOccurrencesOfString:@"file://" + withString:@""]; + + if (![fm fileExistsAtPath:absPath]) { + NSLog(@"File not found: %@", absPath); + } + + return [NSURL fileURLWithPath:absPath]; +} + +/** + * URL to a resource file. + * + * @param [ NSString* ] path A relative file path. + * + * @return [ NSURL* ] + */ +- (NSURL *) urlForResource:(NSString *)path +{ + NSFileManager* fm = [NSFileManager defaultManager]; + NSBundle* mainBundle = [NSBundle mainBundle]; + NSString* bundlePath = [mainBundle resourcePath]; + + if ([path isEqualToString:@"res://icon"]) + { + if (UI_USER_INTERFACE_IDIOM() == UIUserInterfaceIdiomPad) { + path = @"res://AppIcon76x76@2x~ipad.png"; + } else { + path = @"res://AppIcon60x60@2x.png"; + } + } + + NSString* absPath; + absPath = [path stringByReplacingOccurrencesOfString:@"res:/" + withString:@""]; + + absPath = [bundlePath stringByAppendingString:absPath]; + + if (![fm fileExistsAtPath:absPath]) { + NSLog(@"File not found: %@", absPath); + } + + return [NSURL fileURLWithPath:absPath]; +} + +/** + * Returns the file from the www folder as an NSURL object. + * + * @param url A relative www file path. + * + * @return [ NSURL ] + */ +- (NSURL *) urlForAsset:(NSString *)path +{ + NSFileManager* fm = [NSFileManager defaultManager]; + NSBundle* mainBundle = [NSBundle mainBundle]; + NSString* bundlePath = [mainBundle bundlePath]; + + NSString* absPath; + absPath = [path stringByReplacingOccurrencesOfString:@"file:/" + withString:@"/www"]; + + absPath = [bundlePath stringByAppendingString:absPath]; + + if (![fm fileExistsAtPath:absPath]) { + NSLog(@"File not found: %@", absPath); + } + + return [NSURL fileURLWithPath:absPath]; +} + +/** + * Returns the Base64 string as an NSData object. + * + * @param url A valid Base64 string prefixed with base64:// + * + * @return [ NSData ] + */ +- (NSData *) dataFromBase64:(NSString *)url +{ + NSString* base64String = [url substringFromIndex:9]; + + return [[NSData alloc] initWithBase64EncodedString:base64String + options:0]; +} + +@end diff --git a/src/ios/APPPrinterLayout.h b/src/ios/APPPrinterLayout.h new file mode 100644 index 0000000..346417f --- /dev/null +++ b/src/ios/APPPrinterLayout.h @@ -0,0 +1,35 @@ +/* + Copyright 2013 appPlant GmbH + + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. + */ + +@interface APPPrinterLayout : NSObject + ++ (UIPrintFormatter *) configureFormatter:(UIPrintFormatter *)formatter withLayoutFromDictionary:(NSDictionary *)layout; + +// The index of the page for where to apply the layout. +@property(nonatomic) NSInteger pageIndex; +// The margins for each printed page. +@property(nonatomic) UIEdgeInsets contentInsets; +// The maximum height of the content area. +@property(nonatomic) CGFloat maximumContentHeight; +// The maximum width of the content area. +@property(nonatomic) CGFloat maximumContentWidth; + +@end diff --git a/src/ios/APPPrinterLayout.m b/src/ios/APPPrinterLayout.m new file mode 100644 index 0000000..3617aaf --- /dev/null +++ b/src/ios/APPPrinterLayout.m @@ -0,0 +1,101 @@ +/* + Copyright 2013 appPlant GmbH + + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. + */ + +#import "APPPrinterLayout.h" + +@implementation APPPrinterLayout + +#pragma mark - +#pragma mark Init + +- (id) initWithDictionary:(NSDictionary *)spec +{ + self = [self init]; + + NSDictionary* insests = spec[@"padding"]; + double maxWidth = [spec[@"maxWidth"] doubleValue]; + double maxHeight = [spec[@"maxHeight"] doubleValue]; + double dots = [self pointsPerUnit:spec[@"unit"]]; + + _contentInsets = UIEdgeInsetsMake(dots * [insests[@"top"] doubleValue], + dots * [insests[@"left"] doubleValue], + dots * [insests[@"bottom"] doubleValue], + dots * [insests[@"right"] doubleValue]); + + _maximumContentWidth = dots * maxWidth; + + _maximumContentHeight = dots * maxHeight; + + _pageIndex = [spec[@"page"] integerValue]; + + return self; +} + +#pragma mark - +#pragma mark Public + ++ (UIPrintFormatter *) configureFormatter:(UIPrintFormatter *)formatter withLayoutFromDictionary:(NSDictionary *)spec +{ + id layout = [[self alloc] initWithDictionary:spec]; + + [layout configureFormatter:formatter]; + + return formatter; +} + +- (void) configureFormatter:(UIPrintFormatter *)formatter +{ + if (_maximumContentHeight) + { + formatter.maximumContentHeight = _maximumContentHeight; + } + + if (_maximumContentWidth) + { + formatter.maximumContentWidth = _maximumContentWidth; + } + + formatter.perPageContentInsets = _contentInsets; +} + +#pragma mark - +#pragma mark Private + +- (double) pointsPerUnit:(NSString *)unit +{ + if ([unit isEqualToString:@"in"]) + return 72.0; + + if ([unit isEqualToString:@"mm"]) + return 72.0 / 25.4; + + if ([unit isEqualToString:@"cm"]) + return 72.0 / 2.54; + + if (![unit isEqualToString:@"pp"]) + { + NSLog(@"[cordova-plugin-printer] unit not recogniced: %@", unit); + } + + return 1.0; +} + +@end diff --git a/src/ios/APPPrinterPaper.h b/src/ios/APPPrinterPaper.h new file mode 100644 index 0000000..a84c3f7 --- /dev/null +++ b/src/ios/APPPrinterPaper.h @@ -0,0 +1,33 @@ +/* + Copyright 2013 appPlant GmbH + + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. + */ + +@interface APPPrinterPaper : NSObject + +- (id) initWithDictionary:(NSDictionary*)spec; + +- (UIPrintPaper*) bestPaperFromArray:(NSArray *)list; + +// The length to use when cutting the page if using roll printers. +@property(nonatomic) CGFloat length; +// The size of the printed page. +@property(nonatomic) CGSize size; + +@end diff --git a/src/ios/APPPrinterPaper.m b/src/ios/APPPrinterPaper.m new file mode 100644 index 0000000..5ef3ae5 --- /dev/null +++ b/src/ios/APPPrinterPaper.m @@ -0,0 +1,82 @@ +/* + Copyright 2013 appPlant GmbH + + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. + */ + +#import "APPPrinterPaper.h" + +@implementation APPPrinterPaper + +#pragma mark - +#pragma mark Init + +- (id) initWithDictionary:(NSDictionary*)spec +{ + self = [self init]; + + double dots = [self pointsPerUnit:spec[@"unit"]]; + double length = [spec[@"length"] doubleValue]; + double height = [spec[@"height"] doubleValue]; + double width = [spec[@"width"] doubleValue]; + + _size = CGSizeMake(dots * width, dots * height); + _length = dots * length; + + return self; +} + +#pragma mark - +#pragma mark Public + +- (UIPrintPaper*) bestPaperFromArray:(NSArray *)list +{ + UIPrintPaper* paper; + + if (_size.height || _size.width) + { + paper = [UIPrintPaper bestPaperForPageSize:_size + withPapersFromArray:list]; + } + + return paper; +} + +#pragma mark - +#pragma mark Private + +- (double) pointsPerUnit:(NSString*)unit +{ + if ([unit isEqualToString:@"in"]) + return 72.0; + + if ([unit isEqualToString:@"mm"]) + return 72.0 / 25.4; + + if ([unit isEqualToString:@"cm"]) + return 72.0 / 2.54; + + if (![unit isEqualToString:@"pp"]) + { + NSLog(@"[cordova-plugin-printer] unit not recogniced: %@", unit); + } + + return 1.0; +} + +@end diff --git a/www/printer.js b/www/printer.js index f0519f3..e7f6035 100755 --- a/www/printer.js +++ b/www/printer.js @@ -28,15 +28,32 @@ var exec = require('cordova/exec'); */ exports.getDefaults = function () { return { - name: 'unknown', - duplex: 'none', - landscape: false, - graystyle: false, - border: true, + // name: 'unknown', + // duplex: 'none', + // landscape: false, + // graystyle: false, + // border: true, copies: 1, - hideNumberOfCopies: false, - hidePaperFormat: false, - bounds: [40, 30, 0, 0] + + ui: { + hideNumberOfCopies: false, + hidePaperFormat: false, + bounds: [40, 30, 0, 0] + }, + + paper: { + unit: 'cm', + height: 0, + width: 0, + length: 0 + }, + + layout: { + unit: 'cm', + maxHeight: 0, + maxWidth: 0, + padding: { top: 0, left: 0, right: 0, bottom: 0 } + } }; };