Merge lp:~dandrader/platform-api/removeMirClipboard into lp:platform-api

[Daniel d'Andrada]

Remove clipboard implementation

- Using Mir custom messages as the RPC method is bad because
  it's not possible for the server to send a message/signal to the
  client. We need this to tell a client when the global clipboard
  contents have changed. Besides there's currently a bug in mir
  custom messages that hasn't been dealt with.

- The clipboard API is bad. See comments in clipboard.h

This is already dead code as we are currently using D-Bus as the clipboard IPC.

A TODO item is to move the code that does the clipboard access through D-Bus from qtubuntu to here.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:266
http://jenkins.qa.ubuntu.com/job/platform-api-ci/378/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/platform-api-utopic-amd64-ci/111
    SUCCESS: http://jenkins.qa.ubuntu.com/job/platform-api-utopic-armhf-ci/111
        deb: http://jenkins.qa.ubuntu.com/job/platform-api-utopic-armhf-ci/111/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/platform-api-utopic-i386-ci/111

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/platform-api-ci/378/rebuild

review: Approve (continuous-integration)

[Robert Carr (robertcarr)]

LGTM

review: Approve

=== modified file 'CMakeLists.txt'
--- CMakeLists.txt	2014-09-29 20:55:58 +0000
+++ CMakeLists.txt	2014-10-03 15:46:47 +0000
@@ -61,11 +61,6 @@
 pkg_check_modules(MIRSERVER REQUIRED mirserver)
 pkg_check_modules(MIRCLIENT REQUIRED mirclient)
 
-find_package(Protobuf REQUIRED)
-if(PROTOBUF_PROTOC_EXECUTABLE STREQUAL "PROTOBUF_PROTOC_EXECUTABLE-NOTFOUND")
-  message(SEND_ERROR "protoc executable not found! Missing protobuf-compiler package?")
-endif()
-
 # Try to find hybris, and disable hybris from build if not found
 find_library(Hybris
   NAMES hybris-common

=== modified file 'debian/control'
--- debian/control	2014-08-06 08:33:54 +0000
+++ debian/control	2014-10-03 15:46:47 +0000
@@ -23,7 +23,6 @@
                libgtest-dev,
                libprocess-cpp-dev (>= 0.0.1+14.04.20131212),
                libproperties-cpp-dev,
-               protobuf-compiler,
 Standards-Version: 3.9.4
 Homepage: https://launchpad.net/platform-api
 Vcs-Bzr: lp:platform-api

=== modified file 'include/ubuntu/application/ui/clipboard.h'
--- include/ubuntu/application/ui/clipboard.h	2014-02-07 14:32:44 +0000
+++ include/ubuntu/application/ui/clipboard.h	2014-10-03 15:46:47 +0000
@@ -26,6 +26,9 @@
 extern "C" {
 #endif
 
+    /*
+        FIXME: See ua_ui_get_clipboard_content
+    */
     UBUNTU_DLL_PUBLIC void
     ua_ui_set_clipboard_content(
         void* data,
@@ -36,6 +39,11 @@
         Caller is expected to not attempt to modify or delete it.
         It's also not guaranteed to remain valid after any other call is made
         to the Ubuntu Application API.
+
+        FIXME:
+        This API is bad as the user has no idea what kind of data the clipboard
+        contains. It should provide a mapping between mime types (as plain ascii strings)
+        and their respective data so the user is able to interpret the contents properly.
     */
     UBUNTU_DLL_PUBLIC void
     ua_ui_get_clipboard_content(

=== modified file 'src/ubuntu/application/common/mirclient/CMakeLists.txt'
--- src/ubuntu/application/common/mirclient/CMakeLists.txt	2014-08-06 08:33:54 +0000
+++ src/ubuntu/application/common/mirclient/CMakeLists.txt	2014-10-03 15:46:47 +0000
@@ -1,14 +1,8 @@
-protobuf_generate_cpp(
-  GENERATED_PROTOBUF_SRCS GENERATED_PROTOBUF_HDRS
-  unityrpc.proto
-)
-
 set(SOURCES
   ubuntu_application_api_mirclient.cpp
   application_instance_mirclient.cpp
   window_properties_mirclient.cpp
   window_mirclient.cpp
-  ${GENERATED_PROTOBUF_SRCS}
 )
 
 set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} --std=c++11 -fPIC")
@@ -16,7 +10,6 @@
 include_directories(
     ${CMAKE_BINARY_DIR}/include
     ${MIRCLIENT_INCLUDE_DIRS}
-    ${PROTOBUF_INCLUDE_DIRS}
     ${CMAKE_CURRENT_BINARY_DIR}
 )
 
@@ -29,5 +22,4 @@
   ubuntu_application_api_mirclient
 
   ${MIRCLIENT_LDFLAGS} ${MIRCLIENT_LIBRARIES}
-  ${PROTOBUF_LIBRARIES}
 )

=== modified file 'src/ubuntu/application/common/mirclient/application_instance_mirclient.cpp'
--- src/ubuntu/application/common/mirclient/application_instance_mirclient.cpp	2014-02-07 14:32:44 +0000
+++ src/ubuntu/application/common/mirclient/application_instance_mirclient.cpp	2014-10-03 15:46:47 +0000
@@ -22,10 +22,8 @@
 
 uamc::Instance::Instance()
     : con(nullptr),
-      ref_count(1),
-      rpc_waiting_reply(false)
+      ref_count(1)
 {
-    
 }
 
 UApplicationInstance* uamc::Instance::as_u_application_instance()

=== modified file 'src/ubuntu/application/common/mirclient/application_instance_mirclient_priv.h'
--- src/ubuntu/application/common/mirclient/application_instance_mirclient_priv.h	2014-02-07 14:32:44 +0000
+++ src/ubuntu/application/common/mirclient/application_instance_mirclient_priv.h	2014-10-03 15:46:47 +0000
@@ -23,13 +23,9 @@
 
 #include <memory>
 #include <string>
-#include <condition_variable>
-#include <mutex>
 
 #include <mir_toolkit/mir_client_library.h>
 
-#include <unityrpc.pb.h>
-
 namespace ubuntu
 {
 namespace application
@@ -43,27 +39,16 @@
 public:
     Instance();
     ~Instance() = default;
-    
+
     UApplicationInstance* as_u_application_instance();
     static Instance* from_u_application_instance(UApplicationInstance* u_instance);
-    
+
     void ref();
     void unref();
-    
+
     MirConnection* connection() const;
     bool connect(std::string const& application_name);
 
-    // Variables used for direct protobuf manipulation. Needed for calling unity8 functions
-    // through the mir_socket.
-    unity::protobuf::Clip rpc_clip;
-    unity::protobuf::Void rpc_void;
-    std::condition_variable rpc_condition_variable;
-    std::mutex rpc_mutex;
-    bool rpc_waiting_reply;
-    // ensure one clipboard operation (copy or paste) at a time.
-    std::mutex clipboard_api_mutex;
-    std::string clip;
-
 protected:
     Instance(Instance const&) = delete;
     Instance& operator=(Instance const&) = delete;

=== modified file 'src/ubuntu/application/common/mirclient/ubuntu_application_api_mirclient.cpp'
--- src/ubuntu/application/common/mirclient/ubuntu_application_api_mirclient.cpp	2014-09-22 22:52:59 +0000
+++ src/ubuntu/application/common/mirclient/ubuntu_application_api_mirclient.cpp	2014-10-03 15:46:47 +0000
@@ -142,75 +142,18 @@
     (void) instance;
 }
 
-namespace {
-void got_rpc_reply_callback(uamc::Instance* instance)
-{
-    {
-        std::unique_lock<std::mutex> rpc_lock(instance->rpc_mutex);
-        instance->rpc_waiting_reply = false;
-    }
-    instance->rpc_condition_variable.notify_all();
-}
-} // anonymous namespace
-
-void ua_ui_set_clipboard_content(void* content, size_t content_size)
-{
-    // TODO<papi>: We will need a MirConnection.
-    //             Add a non-blocking version?
-
-    uamc::Instance* instance = global_mir_instance();
-    std::unique_lock<std::mutex> clipboard_lock(instance->clipboard_api_mutex);
-    std::unique_lock<std::mutex> rpc_lock(instance->rpc_mutex);
-    auto const rpc_channel = mir::client::the_rpc_channel(instance->connection());
-
-    std::string contentString(reinterpret_cast<char*>(content), content_size);
-
-    unity::protobuf::UnityService::Stub unityService(rpc_channel.get(),
-        google::protobuf::Service::STUB_DOESNT_OWN_CHANNEL);
-
-    instance->rpc_clip.set_content(contentString);
-
-    instance->rpc_waiting_reply = true;
-    unityService.copy(
-        nullptr, /* rpc_controller */
-        &instance->rpc_clip, /* request  */
-        &instance->rpc_void,
-        google::protobuf::NewCallback(&got_rpc_reply_callback, instance));
-
-    // Wait until we get a reply from the server
-    instance->rpc_condition_variable.wait(rpc_lock, [&]{return !instance->rpc_waiting_reply;});
+void ua_ui_set_clipboard_content(void* /*content*/, size_t /*content_size*/)
+{
+    // TODO<papi>: Fix API and implement it
+    printf("ERROR: ua_ui_set_clipboard_content() is not implemented!\n");
 }
 
 void ua_ui_get_clipboard_content(void** out_content, size_t* out_content_size)
 {
-    // TODO<papi>: see get_clipboard_comment.
-
-    uamc::Instance* instance = global_mir_instance();
-    std::unique_lock<std::mutex> clipboard_lock(instance->clipboard_api_mutex);
-    std::unique_lock<std::mutex> rpc_lock(instance->rpc_mutex);
-
-    *out_content = NULL;
+    // TODO<papi>: Fix API and implement it
+    printf("ERROR: ua_ui_get_clipboard_content() is not implemented!\n");
+    *out_content = nullptr;
     *out_content_size = 0;
-
-    auto const rpc_channel = mir::client::the_rpc_channel(instance->connection());
-    unity::protobuf::UnityService::Stub unityService(rpc_channel.get(),
-        google::protobuf::Service::STUB_DOESNT_OWN_CHANNEL);
-
-    unityService.paste(
-        nullptr, /* rpc_controller */
-        &instance->rpc_void, /* request */
-        &instance->rpc_clip, /* response */
-        google::protobuf::NewCallback(&got_rpc_reply_callback, instance));
-
-    // Wait until we get a reply from the server
-    instance->rpc_condition_variable.wait(rpc_lock, [&]{return !instance->rpc_waiting_reply;});
-
-    instance->clip = instance->rpc_clip.content();
-    if (!instance->clip.empty()) {
-        *out_content_size = instance->clip.size();
-        // argh!
-        *out_content = const_cast<void*>(static_cast<const void*>(instance->clip.data()));
-    }
 }
 
 //

=== removed file 'src/ubuntu/application/common/mirclient/unityrpc.proto'
--- src/ubuntu/application/common/mirclient/unityrpc.proto	2014-02-07 14:32:44 +0000
+++ src/ubuntu/application/common/mirclient/unityrpc.proto	1970-01-01 00:00:00 +0000
@@ -1,17 +0,0 @@
-option cc_generic_services = true;
-
-package unity.protobuf;
-
-message Clip {
-  required bytes content = 1;
-  optional string error = 127;
-}
-
-message Void {
-  optional string error = 127;
-}
-
-service UnityService {
-  rpc copy(Clip) returns (Void);
-  rpc paste(Void) returns (Clip);
-}