16 Commits
3.0.0 ... 4.0.0

Author SHA1 Message Date
StefanoMagrassi
4dc72591ee version 4.0.0 2016-04-13 10:15:33 +02:00
StefanoMagrassi
1de7e2d5f5 Merge branch 'issue#4'
resolves #4
2016-04-13 10:14:24 +02:00
StefanoMagrassi
3e6b70dba7 manage default prefix only in js 2016-04-13 10:11:05 +02:00
StefanoMagrassi
42ee53b9e9 notes for options parameter in README 2016-04-13 10:09:52 +02:00
StefanoMagrassi
8177ea902e make requiring work 2016-04-13 09:09:26 +02:00
StefanoMagrassi
cbdd6cd3d1 Object.assign local polyfill 2016-04-12 17:52:05 +02:00
StefanoMagrassi
ba52ad27a7 media scanner option in camel case 2016-04-12 12:35:13 +02:00
Bastian Meier
92a9cc577b mediaScanner in camelcase 2016-04-12 12:34:17 +02:00
Bastian Meier
3d78e43388 options.medisScanner should be Camelcase 2016-04-12 12:34:06 +02:00
Bastian Meier
fff731c9e3 fix for 'mediaSanner wrong type'-bug 2016-04-12 12:27:16 +02:00
StefanoMagrassi
7afc399a3a update version -> bump version 2016-04-12 09:17:11 +02:00
StefanoMagrassi
03dc4f65bb updated documentation 2016-04-12 09:05:04 +02:00
StefanoMagrassi
87ffe30dd3 options object in base64ToGallery api 2016-04-12 09:04:44 +02:00
StefanoMagrassi
fdae1613eb run media scanner only if enabled through options 2016-04-11 17:09:55 +02:00
StefanoMagrassi
b56e720048 cleanup 2016-04-11 17:08:16 +02:00
StefanoMagrassi
8ae80d457c npm -> save exact version and show no progress bar 2016-04-11 15:31:22 +02:00
10 changed files with 204 additions and 128 deletions

2
.npmrc
View File

@@ -1,2 +1,4 @@
git-tag-version = false
tag-version-prefix =
save-exact = true
progress = false

View File

@@ -17,20 +17,31 @@ So, cordova-base64-to-gallery plugin **from version 3.0.0** has changed the iOS
If you need to support cordova-ios < 3.8.0 please refer to [cordova-base64-to-gallery@2.0.2](https://github.com/Nexxa/cordova-base64-to-gallery/tree/2.0.2). There is also an "**old**" branch that might have some updates in the future (Android/WP8 fixes or something like that).
## Usage
Call the `cordova.base64ToGallery()` method using success and error callbacks and the id attribute or the element object of the canvas to save (`prefix` is optional):
Call the `cordova.base64ToGallery()` method using success and error callbacks and the passing the image's base64 string (`options` is optional):
### Methods
#### `cordova.base64ToGallery(data, [prefix, success, fail])`
#### `cordova.base64ToGallery(data, [options, success, fail])`
Param | Type | Default | Description
----------- | ---------- | ----------------- | ------------------
**data** | *string* | | base64 string
**prefix** | *string* | **img_** | file's name prefix
**options** | *object* | \*see below | options
**success** | *function* | **console.log** | success callback
**fail** | *function* | **console.error** | fail callback
#### Available options *
##### `prefix`
Saved file name prefix. Only works in Android and WP8.
**Default**: "img_"
##### `mediaScanner`
Android Media Scanner after file creation enabled or not. Only works in Android.
**Default**: true
### Example
```javascript
@@ -38,13 +49,16 @@ function onDeviceReady() {
cordova.base64ToGallery(
base64Data,
'img_',
{
prefix: 'img_',
mediaScanner: true
},
function(msg){
function(msg) {
console.log(msg);
},
function(err){
function(err) {
console.error(err);
}
);

View File

@@ -1,10 +1,10 @@
{
"name": "cordova-base64-to-gallery",
"version": "3.0.0",
"version": "4.0.0",
"description": "Cordova plugin to save base64 data as a png image into the device",
"license": "MIT",
"scripts": {
"update": "node ./scripts/update_version",
"bump": "node ./scripts/bump_version",
"lint": "eslint www/base64ToGallery.js",
"test": "npm run lint",
"prepublish": "npm test"
@@ -21,7 +21,7 @@
"cordova": ">=3.0.0"
},
{
"node": ">=0.10"
"node": ">=0.12"
}
],
"cordova": {

View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<plugin xmlns:android="http://schemas.android.com/apk/res/android" xmlns="http://www.phonegap.com/ns/plugins/1.0" id="cordova-base64-to-gallery" version="3.0.0">
<plugin xmlns:android="http://schemas.android.com/apk/res/android" xmlns="http://www.phonegap.com/ns/plugins/1.0" id="cordova-base64-to-gallery" version="4.0.0">
<engines>
<engine name="cordova-ios" version=">=3.8.0" />
@@ -15,6 +15,9 @@
<license>MIT</license>
<js-module name="object.assign-polyfill" src="www/object.assign-polyfill.js">
</js-module>
<js-module name="base64ToGallery" src="www/base64ToGallery.js">
<clobbers target="cordova.base64ToGallery"/>
</js-module>

View File

@@ -30,119 +30,109 @@ import android.util.Log;
*/
public class Base64ToGallery extends CordovaPlugin {
// Consts
public static final String ACTION = "saveImageDataToLibrary";
public static final String DEFAULT_FILE_PREFIX = "img_";
public static final String EMPTY_STR = "";
// Consts
public static final String EMPTY_STR = "";
@Override
public boolean execute(String action, JSONArray args,
CallbackContext callbackContext) throws JSONException {
@Override
public boolean execute(String action, JSONArray args,
CallbackContext callbackContext) throws JSONException {
if (action.equals(ACTION)) {
String base64 = args.optString(0);
String filePrefix = args.optString(1);
boolean mediaScannerEnabled = args.optBoolean(2);
String base64 = args.optString(0);
String filePrefix = args.optString(1);
// isEmpty() requires API level 9
if (base64.equals(EMPTY_STR)) {
callbackContext.error("Missing base64 string");
}
// isEmpty() requires API level 9
if (base64.equals(EMPTY_STR)) {
callbackContext.error("Missing base64 string");
}
// Create the bitmap from the base64 string
byte[] decodedString = Base64.decode(base64, Base64.DEFAULT);
Bitmap bmp = BitmapFactory.decodeByteArray(decodedString, 0, decodedString.length);
if (filePrefix.equals(EMPTY_STR)) {
filePrefix = DEFAULT_FILE_PREFIX;
}
if (bmp == null) {
callbackContext.error("The image could not be decoded");
// Create the bitmap from the base64 string
byte[] decodedString = Base64.decode(base64, Base64.DEFAULT);
Bitmap bmp = BitmapFactory.decodeByteArray(decodedString, 0, decodedString.length);
} else {
if (bmp == null) {
callbackContext.error("The image could not be decoded");
// Save the image
File imageFile = savePhoto(bmp, filePrefix);
} else {
if (imageFile == null) {
callbackContext.error("Error while saving image");
}
// Save the image
File imageFile = savePhoto(bmp, filePrefix);
// Update image gallery
if (mediaScannerEnabled) {
scanPhoto(imageFile);
}
if (imageFile == null) {
callbackContext.error("Error while saving image");
}
callbackContext.success(imageFile.toString());
}
// Update image gallery
scanPhoto(imageFile);
return true;
}
callbackContext.success(imageFile.toString());
}
private File savePhoto(Bitmap bmp, String prefix) {
File retVal = null;
return true;
try {
String deviceVersion = Build.VERSION.RELEASE;
Calendar c = Calendar.getInstance();
String date = EMPTY_STR
+ c.get(Calendar.YEAR)
+ c.get(Calendar.MONTH)
+ c.get(Calendar.DAY_OF_MONTH)
+ c.get(Calendar.HOUR_OF_DAY)
+ c.get(Calendar.MINUTE)
+ c.get(Calendar.SECOND);
} else {
int check = deviceVersion.compareTo("2.3.3");
return false;
}
}
File folder;
private File savePhoto(Bitmap bmp, String prefix) {
File retVal = null;
/*
* File path = Environment.getExternalStoragePublicDirectory(
* Environment.DIRECTORY_PICTURES ); //this throws error in Android
* 2.2
*/
if (check >= 1) {
folder = Environment.getExternalStoragePublicDirectory(Environment.DIRECTORY_PICTURES);
try {
String deviceVersion = Build.VERSION.RELEASE;
Calendar c = Calendar.getInstance();
String date = EMPTY_STR
+ c.get(Calendar.YEAR)
+ c.get(Calendar.MONTH)
+ c.get(Calendar.DAY_OF_MONTH)
+ c.get(Calendar.HOUR_OF_DAY)
+ c.get(Calendar.MINUTE)
+ c.get(Calendar.SECOND);
if (!folder.exists()) {
folder.mkdirs();
}
int check = deviceVersion.compareTo("2.3.3");
} else {
folder = Environment.getExternalStorageDirectory();
}
File folder;
File imageFile = new File(folder, prefix + date + ".png");
/*
* File path = Environment.getExternalStoragePublicDirectory(
* Environment.DIRECTORY_PICTURES ); //this throws error in Android
* 2.2
*/
if (check >= 1) {
folder = Environment.getExternalStoragePublicDirectory(Environment.DIRECTORY_PICTURES);
FileOutputStream out = new FileOutputStream(imageFile);
bmp.compress(Bitmap.CompressFormat.PNG, 100, out);
out.flush();
out.close();
if (!folder.exists()) {
folder.mkdirs();
}
retVal = imageFile;
} else {
folder = Environment.getExternalStorageDirectory();
}
} catch (Exception e) {
Log.e("Base64ToGallery", "An exception occured while saving image: " + e.toString());
}
File imageFile = new File(folder, prefix + date + ".png");
return retVal;
}
FileOutputStream out = new FileOutputStream(imageFile);
bmp.compress(Bitmap.CompressFormat.PNG, 100, out);
out.flush();
out.close();
retVal = imageFile;
} catch (Exception e) {
Log.e("Base64ToGallery", "An exception occured while saving image: " + e.toString());
}
return retVal;
}
/**
* Invoke the system's media scanner to add your photo to the Media Provider's database,
* making it available in the Android Gallery application and to other apps.
*/
private void scanPhoto(File imageFile) {
Intent mediaScanIntent = new Intent(Intent.ACTION_MEDIA_SCANNER_SCAN_FILE);
/**
* Invoke the system's media scanner to add your photo to the Media Provider's database,
* making it available in the Android Gallery application and to other apps.
*/
private void scanPhoto(File imageFile) {
Intent mediaScanIntent = new Intent(Intent.ACTION_MEDIA_SCANNER_SCAN_FILE);
Uri contentUri = Uri.fromFile(imageFile);
mediaScanIntent.setData(contentUri);
cordova.getActivity().sendBroadcast(mediaScanIntent);
}
cordova.getActivity().sendBroadcast(mediaScanIntent);
}
}

View File

@@ -13,11 +13,6 @@
@interface Base64ToGallery : CDVPlugin
//{
// NSString* callbackId;
// CDVPluginResult* result;
//}
@property (nonatomic, copy) NSString* callbackId;
@property (nonatomic, assign) CDVPluginResult* result;

View File

@@ -22,11 +22,6 @@ public class Base64ToGallery : BaseCommand
string prefix = options[1];
byte[] imageBytes = Convert.FromBase64String(imageData);
if (String.IsNullOrEmpty(prefix))
{
prefix = "img_";
}
using (var imageStream = new MemoryStream(imageBytes))
{
imageStream.Seek(0, SeekOrigin.Begin);

View File

@@ -7,48 +7,52 @@
* @license MIT
*/
/*globals cordova*/
var exec = require('cordova/exec');
var assign = require('./object.assign-polyfill');
// Consts
// ------
var SERVICE = 'Base64ToGallery';
var ACTION = 'saveImageDataToLibrary';
var SERVICE = 'Base64ToGallery';
var ACTION = 'saveImageDataToLibrary';
var ARGS = ['data', 'prefix', 'mediaScanner'];
var DEFAULTS = { prefix: 'img_', mediaScanner: true };
/**
* @property indexFromArgs - Partially applied "indexFrom" method with ARGS constant.
* @private
*/
var indexFromArgs = indexFrom.bind(null, ARGS);
// Exports
// -------
/**
* Saves base64 data as image.
* @public
* @param {string} data
* @param {string} [prefix]
* @param {function} [success]
* @param {function} [fail]
* @return {undefined}
*/
module.exports = function(data, prefix, success, fail) {
// Handle method call with 3 or 4 parameters (prefix optional)
if (arguments.length < 4) {
prefix = '';
success = arguments[1];
fail = arguments[2];
}
module.exports = function(data, options, success, fail) {
var spec = assign(DEFAULTS, options);
var actionArgs = prepareArgs(spec);
// Prepare base64 string
data = data.replace(/data:image\/png;base64,/, '');
return cordova.exec(ok(success), error(fail), SERVICE, ACTION, [data, prefix]);
// And add it to the Service's Action arguments
actionArgs.unshift(data);
return exec(ok(success), error(fail), SERVICE, ACTION, actionArgs);
};
// Private methods
// ---------------
/**
* Gets success callback if it is defined and not null.
* Otherwise returns a simple console.log.
*
* @private
* @param {[function|undefined|null]} success
* @return {function}
*/
function ok(success) {
if (typeof success === 'undefined' || success === null) {
if (typeof success !== 'function') {
return console.log;
}
@@ -58,14 +62,53 @@ function ok(success) {
/**
* Gets fail callback if it is defined and not null.
* Otherwise returns a simple console.error.
*
* @private
* @param {[function|undefined|null]} fail
* @return {function}
*/
function error(fail) {
if (typeof fail === 'undefined' || fail === null) {
if (typeof fail !== 'function') {
return console.error;
}
return fail;
}
/**
* Gets index of item from array.
* @private
* @param {array} fromArr - Source array
* @param {*} item - Item
* @return {number} Index of item in array
*/
function indexFrom(fromArr, item) {
return fromArr.indexOf(item);
}
/**
* Gets value of property with specified key from object.
* @private
* @param {object} fromObj - Source object
* @param {string} key - Property key
* @return {*} Property value
*/
function valueFrom(fromObj, key) {
return fromObj[key];
}
/**
* Prepares parameter to pass to Service's Action.<br/>
* Sort options value in order to match "arguments" proto.
* @private
* @param {object} opts - Options object
* @return {array} Arguments array
*/
function prepareArgs(opts) {
var valueFromOpts = valueFrom.bind(null, opts);
return Object.keys(opts).reduce(function(acc, item) {
acc.splice(indexFromArgs(item), 0, valueFromOpts(item));
return acc;
}, []);
}

View File

@@ -0,0 +1,34 @@
if (!Object.assign) {
Object.defineProperty(Object, 'assign', {
enumerable: false,
configurable: true,
writable: true,
value: function(target) {
'use strict';
if (target === undefined || target === null) {
throw new TypeError('Cannot convert first argument to object');
}
var to = Object(target);
for (var i = 1; i < arguments.length; i++) {
var nextSource = arguments[i];
if (nextSource === undefined || nextSource === null) {
continue;
}
nextSource = Object(nextSource);
var keysArray = Object.keys(Object(nextSource));
for (var nextIndex = 0, len = keysArray.length; nextIndex < len; nextIndex++) {
var nextKey = keysArray[nextIndex];
var desc = Object.getOwnPropertyDescriptor(nextSource, nextKey);
if (desc !== undefined && desc.enumerable) {
to[nextKey] = nextSource[nextKey];
}
}
}
return to;
}
});
}
module.exports = Object.assign;