New screenshotr service plus idevicescreenshot tool

[#113 state:resolved]

3 files changed, 218 insertions, 0 deletions

diff --git a/src/Makefile.am b/src/Makefile.am
index e847d7c..87fada0 100644
--- a/src/Makefile.am
+++ b/src/Makefile.am
@@ -17,5 +17,6 @@ libimobiledevice_la_SOURCES = idevice.c idevice.h \
 		       installation_proxy.c installation_proxy.h\
 		       sbservices.c sbservices.h\
 		       mobile_image_mounter.c mobile_image_mounter.h\
+		       screenshotr.c screenshotr.h\
 		       mobilesync.c mobilesync.h\
 		       mobilebackup.c mobilebackup.h
diff --git a/src/screenshotr.c b/src/screenshotr.c
new file mode 100644
index 0000000..f8866d0
--- /dev/null
+++ b/src/screenshotr.c
@@ -0,0 +1,186 @@
+/*
+ * screenshotr.c 
+ * com.apple.mobile.screenshotr implementation.
+ * 
+ * Copyright (c) 2010 Nikias Bassen All Rights Reserved.
+ *
+ * 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.1 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
+ * Lesser 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  02110-1301  USA 
+ */
+
+#include <plist/plist.h>
+#include <string.h>
+#include <stdlib.h>
+#include <arpa/inet.h>
+
+#include "screenshotr.h"
+#include "device_link_service.h"
+#include "debug.h"
+
+#define SCREENSHOTR_VERSION_INT1 100
+#define SCREENSHOTR_VERSION_INT2 0
+
+/**
+ * Convert a device_link_service_error_t value to a screenshotr_error_t value.
+ * Used internally to get correct error codes.
+ *
+ * @param err An device_link_service_error_t error code
+ *
+ * @return A matching screenshotr_error_t error code,
+ *     SCREENSHOTR_E_UNKNOWN_ERROR otherwise.
+ */
+static screenshotr_error_t screenshotr_error(device_link_service_error_t err)
+{
+	switch (err) {
+		case DEVICE_LINK_SERVICE_E_SUCCESS:
+			return SCREENSHOTR_E_SUCCESS;
+		case DEVICE_LINK_SERVICE_E_INVALID_ARG:
+			return SCREENSHOTR_E_INVALID_ARG;
+		case DEVICE_LINK_SERVICE_E_PLIST_ERROR:
+			return SCREENSHOTR_E_PLIST_ERROR;
+		case DEVICE_LINK_SERVICE_E_MUX_ERROR:
+			return SCREENSHOTR_E_MUX_ERROR;
+		case DEVICE_LINK_SERVICE_E_BAD_VERSION:
+			return SCREENSHOTR_E_BAD_VERSION;
+		default:
+			break;
+	}
+	return SCREENSHOTR_E_UNKNOWN_ERROR;
+}
+
+/**
+ * Makes a connection to the screenshotr service on the device.
+ *
+ * @param device The device to connect to.
+ * @param port Destination port (usually given by lockdownd_start_service).
+ * @param client Pointer that will be set to a newly allocated
+ *     screenshotr_client_t upon successful return.
+ *
+ * @return SCREENSHOTR_E_SUCCESS on success, SCREENSHOTR_E_INVALID ARG if one
+ *     or more parameters are invalid, or SCREENSHOTR_E_CONN_FAILED if the
+ *     connection to the device could not be established.
+ */
+screenshotr_error_t screenshotr_client_new(idevice_t device, uint16_t port,
+					   screenshotr_client_t * client)
+{
+	if (!device || port == 0 || !client || *client)
+		return SCREENSHOTR_E_INVALID_ARG;
+
+	device_link_service_client_t dlclient = NULL;
+	screenshotr_error_t ret = screenshotr_error(device_link_service_client_new(device, port, &dlclient));
+	if (ret != SCREENSHOTR_E_SUCCESS) {
+		return ret;
+	}
+
+	screenshotr_client_t client_loc = (screenshotr_client_t) malloc(sizeof(struct screenshotr_client_int));
+	client_loc->parent = dlclient;
+
+	/* perform handshake */
+	ret = screenshotr_error(device_link_service_version_exchange(dlclient, SCREENSHOTR_VERSION_INT1, SCREENSHOTR_VERSION_INT2));
+	if (ret != SCREENSHOTR_E_SUCCESS) {
+		debug_info("version exchange failed, error %d", ret);
+		screenshotr_client_free(client_loc);
+		return ret;
+	}
+
+	*client = client_loc;
+
+	return ret;
+}
+
+/**
+ * Disconnects a screenshotr client from the device.
+ *
+ * @param client The client to disconnect.
+ *
+ * @return SCREENSHOTR_E_SUCCESS on success, or SCREENSHOTR_E_INVALID_ARG
+ *     if client is NULL.
+ */
+screenshotr_error_t screenshotr_client_free(screenshotr_client_t client)
+{
+	if (!client)
+		return SCREENSHOTR_E_INVALID_ARG;
+	device_link_service_disconnect(client->parent);
+	screenshotr_error_t err = screenshotr_error(device_link_service_client_free(client->parent));
+	free(client);
+	return err;
+}
+
+/**
+ * Get a screen shot from the connected device.
+ *
+ * @param client The connection screenshotr service client.
+ * @param imgdata Pointer that will point to a newly allocated buffer
+ *     containing TIFF image data upon successful return. It is up to the
+ *     caller to free the memory.
+ * @param imgsize Pointer to a uint64_t that will be set to the size of the
+ *     buffer imgdata points to upon successful return.
+ *
+ * @return SCREENSHOTR_E_SUCCESS on success, SCREENSHOTR_E_INVALID_ARG if
+ *     one or more parameters are invalid, or another error code if an
+ *     error occured.
+ */
+screenshotr_error_t screenshotr_take_screenshot(screenshotr_client_t client, char **imgdata, uint64_t *imgsize)
+{
+	if (!client || !client->parent || !imgdata)
+		return SCREENSHOTR_E_INVALID_ARG;
+
+	screenshotr_error_t res = SCREENSHOTR_E_UNKNOWN_ERROR;
+
+	plist_t dict = plist_new_dict();
+	plist_dict_insert_item(dict, "MessageType", plist_new_string("ScreenShotRequest"));
+
+	res = screenshotr_error(device_link_service_process_message(client->parent, dict));
+	plist_free(dict);
+	if (res != SCREENSHOTR_E_SUCCESS) {
+		debug_info("could not send plist, error %d", res);
+		return res;
+	}
+
+	dict = NULL;
+	res = screenshotr_error(device_link_service_get_process_message(client->parent, &dict));
+	if (res != SCREENSHOTR_E_SUCCESS) {
+		debug_info("could not get screenshot data, error %d", res);
+		goto leave;
+	}
+	if (!dict) {
+		debug_info("did not receive screenshot data!");
+		res = SCREENSHOTR_E_PLIST_ERROR;
+		goto leave;
+	}
+
+	plist_t node = plist_dict_get_item(dict, "MessageType");
+	char *strval = NULL;
+	plist_get_string_val(node, &strval);
+	if (!strval || strcmp(strval, "ScreenShotReply")) {
+		debug_info("invalid screenshot data received!");
+		res = SCREENSHOTR_E_PLIST_ERROR;
+		goto leave;
+	}
+	node = plist_dict_get_item(dict, "ScreenShotData");
+	if (!node || plist_get_node_type(node) != PLIST_DATA) {
+		debug_info("no PNG data received!");
+		res = SCREENSHOTR_E_PLIST_ERROR;
+		goto leave;
+	}
+
+	plist_get_data_val(node, imgdata, imgsize);
+	res = SCREENSHOTR_E_SUCCESS;
+
+leave:
+	if (dict)
+		plist_free(dict);
+
+	return res;
+}
diff --git a/src/screenshotr.h b/src/screenshotr.h
new file mode 100644
index 0000000..5f842a7
--- /dev/null
+++ b/src/screenshotr.h
@@ -0,0 +1,31 @@
+/* 
+ * screenshotr.h
+ * com.apple.mobile.screenshotr definitions.
+ * 
+ * Copyright (c) 2010 Nikias Bassen All Rights Reserved.
+ *
+ * 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.1 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
+ * Lesser 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  02110-1301  USA 
+ */
+#ifndef SCREENSHOTR_H
+#define SCREENSHOTR_H
+
+#include "libimobiledevice/screenshotr.h"
+#include "device_link_service.h"
+
+struct screenshotr_client_int {
+	device_link_service_client_t parent;
+};
+
+#endif