Merge lp:~xavi-garcia-mena/go-unityscopes/list-all-scopes-metadata into lp:go-unityscopes/v2

[Xavi Garcia]

I've added the ScopeMetadata to the go-bindings in order to implement the method that lists all the existing scopes in the registry. ListRegistryScopes() in ScopeBase.

I've added the ScopeMetadata to the go-bindings in order to implement the method that lists all the existing scopes in the registry. ListRegistryScopes() in ScopeBase.

The idea would be to keep a pointer to the C++ ScopeMetadata when we need it to implement "find_child_scopes" as there is no way to create a new instance of the C++ ScopeMetadata using the public API. The C++ ScopeMetadata holds a pointer to the Middleware.

For the rest of attributes of ScopeMetadata I've created a copy in the go space to avoid making a C_go call every time we need to query for something.

This would be the base for the rest of the implementation for supporting aggregated scopes, so I'm moving to MP so it gets reviewed first.

There is a very basic test on the test scope that prints out the metadata obtained to stdout. That test should be removed when we have a more reliable way of testing this (using scope-harness possibly).

The idea would be to add next the ChildScope class, which holds the ScopeMetadata along with other attributes and implement the "clild_scopes" method in ScopeBase as well as the "find_child_scopes"

[lp:~xavi-garcia-mena/go-unityscopes/list-all-scopes-metadata]

70. By Xavi Garcia on 2015-05-21

Changed shared_ptr to ScopeMetadata to raw pointers

[James Henstridge (jamesh)]

This looks pretty good. I've left a few inline comments for some small issues I noticed. It looks like you're on the right track.

review: Needs Fixing

[lp:~xavi-garcia-mena/go-unityscopes/list-all-scopes-metadata]

71. By Xavi Garcia on 2015-05-21

Added suggested changes

[Xavi Garcia (xavi-garcia-mena)]

Thanks for the review.

I've also left inline comments.

[lp:~xavi-garcia-mena/go-unityscopes/list-all-scopes-metadata]

72. By Xavi Garcia on 2015-05-21

Added Keywords to ScopeMetadata

[James Henstridge (jamesh)]

Looks good.

review: Approve

=== modified file 'export_test.go'
--- export_test.go	2015-03-02 05:41:40 +0000
+++ export_test.go	2015-05-21 14:58:20 +0000
@@ -1,7 +1,20 @@
 package scopes
 
+import (
+	"encoding/json"
+)
+
 // This file exports certain private functions for use by tests.
 
 func NewTestingResult() *Result {
 	return newTestingResult()
 }
+
+func NewTestingScopeMetadata(json_data string) ScopeMetadata {
+	var scopeMetadata ScopeMetadata
+	if err := json.Unmarshal([]byte(json_data), &scopeMetadata); err != nil {
+		panic(err)
+	}
+
+	return scopeMetadata
+}

=== modified file 'metadata.cpp'
--- metadata.cpp	2015-04-17 09:54:06 +0000
+++ metadata.cpp	2015-05-21 14:58:20 +0000
@@ -4,6 +4,7 @@
 
 #include <unity/scopes/ActionMetadata.h>
 #include <unity/scopes/SearchMetadata.h>
+#include <unity/scopes/ScopeMetadata.h>
 #include <unity/scopes/ScopeExceptions.h>
 
 extern "C" {
@@ -173,3 +174,12 @@
     }
     return as_bytes(Variant(hints).serialize_json(), length);
 }
+
+char *get_scope_metadata_serialized(_ScopeMetadata *metadata) {
+    ScopeMetadata const*api_metadata = reinterpret_cast<ScopeMetadata const*>(metadata);
+    return strdup(Variant(api_metadata->serialize()).serialize_json().c_str());
+}
+
+void destroy_scope_metadata_ptr(_ScopeMetadata *metadata) {
+    delete reinterpret_cast<ScopeMetadata*>(metadata);
+}

=== modified file 'metadata.go'
--- metadata.go	2015-04-17 09:54:06 +0000
+++ metadata.go	2015-05-21 14:58:20 +0000
@@ -264,3 +264,46 @@
 	RegionName         string       `json:"region_name"`
 	ZipPostalCode      string       `json:"zip_postal_code"`
 }
+
+type ProxyScopeMetadata struct {
+	Identity string `json:"identity"`
+	EndPoint string `json:"endpoint"`
+}
+
+// ScopeMetadata holds scope attributes such as name, description, icon etc.
+//
+// The information stored by ScopeMetadata comes from the .ini file for the given scope (for local scopes)
+// or is fetched from the remote server (for scopes running on Smart Scopes Server).
+// Use ListRegistryScopes from ScopeBase to get the metadata for all scopes.
+type ScopeMetadata struct {
+	m                    *C._ScopeMetadata
+	Art                  string                 `json:"art"`
+	Author               string                 `json:"author"`
+	Description          string                 `json:"description"`
+	DisplayName          string                 `json:"display_name"`
+	Icon                 string                 `json:"icon"`
+	Invisible            bool                   `json:"invisible"`
+	IsAggregator         bool                   `json:"is_aggregator"`
+	LocationDataNeeded   bool                   `json:"location_data_needed"`
+	ScopeDir             string                 `json:"scope_dir"`
+	ScopeId              string                 `json:"scope_id"`
+	Version              int                    `json:"version"`
+	Proxy                ProxyScopeMetadata     `json:"proxy"`
+	AppearanceAttributes map[string]interface{} `json:"appearance_attributes"`
+	SettingsDefinitions  []interface{}          `json:"settings_definitions"`
+	Keywords             []string               `json:"keywords"`
+}
+
+func finalizeScopeMetadata(metadata *ScopeMetadata) {
+	C.destroy_scope_metadata_ptr(metadata.m)
+}
+
+func makeScopeMetadata(m *C._ScopeMetadata, json_data string) *ScopeMetadata {
+	metadata := new(ScopeMetadata)
+	if err := json.Unmarshal([]byte(json_data), &metadata); err != nil {
+		panic(err)
+	}
+	metadata.m = m
+	runtime.SetFinalizer(metadata, finalizeScopeMetadata)
+	return metadata
+}

=== modified file 'metadata_test.go'
--- metadata_test.go	2015-04-17 09:54:06 +0000
+++ metadata_test.go	2015-05-21 14:58:20 +0000
@@ -146,3 +146,30 @@
 	c.Assert(err, Not(Equals), nil)
 	c.Check(err.Error(), Equals, "json: error calling MarshalJSON for type *scopes_test.unserializable: Can not marshal to JSON")
 }
+
+func (s *S) TestScopeMetadataCreation(c *C) {
+	json_data := "{\"appearance_attributes\":{\"page-header\":{\"background\":\"color:///#ffffff\",\"divider-color\":\"#b31217\",\"logo\":\"unity-scope-youtube/build/src/logo.png\"}},\"art\":\"unity-scope-youtube/build/src/screenshot.jpg\",\"author\":\"Canonical Ltd.\",\"description\":\"Search YouTube for videos and browse channels\",\"display_name\":\"YouTube\",\"icon\":\"unity-scope-youtube/build/src/icon.png\",\"invisible\":false,\"is_aggregator\":false,\"location_data_needed\":true,\"proxy\":{\"endpoint\":\"ipc:///tmp/scope-dev-endpoints.V4gbrE/priv/com.ubuntu.scopes.youtube_youtube\",\"identity\":\"com.ubuntu.scopes.youtube_youtube\"},\"scope_dir\":\"unity-scope-youtube/build/src\",\"scope_id\":\"com.ubuntu.scopes.youtube_youtube\",\"settings_definitions\":[{\"defaultValue\":true,\"displayName\":\"Enable location data\",\"id\":\"internal.location\",\"type\":\"boolean\"}],\"version\":0,\"keywords\":[\"music\",\"video\"]}"
+
+	scopeMetadata := scopes.NewTestingScopeMetadata(json_data)
+	c.Assert(scopeMetadata, Not(Equals), nil)
+
+	c.Check(scopeMetadata.Art, Equals, "unity-scope-youtube/build/src/screenshot.jpg")
+	c.Check(scopeMetadata.Author, Equals, "Canonical Ltd.")
+	c.Check(scopeMetadata.Description, Equals, "Search YouTube for videos and browse channels")
+	c.Check(scopeMetadata.DisplayName, Equals, "YouTube")
+	c.Check(scopeMetadata.Icon, Equals, "unity-scope-youtube/build/src/icon.png")
+	c.Check(scopeMetadata.Invisible, Equals, false)
+	c.Check(scopeMetadata.IsAggregator, Equals, false)
+	c.Check(scopeMetadata.LocationDataNeeded, Equals, true)
+	c.Check(scopeMetadata.ScopeDir, Equals, "unity-scope-youtube/build/src")
+	c.Check(scopeMetadata.ScopeId, Equals, "com.ubuntu.scopes.youtube_youtube")
+	c.Check(scopeMetadata.Version, Equals, 0)
+	c.Check(scopeMetadata.Proxy, Equals, scopes.ProxyScopeMetadata{"com.ubuntu.scopes.youtube_youtube", "ipc:///tmp/scope-dev-endpoints.V4gbrE/priv/com.ubuntu.scopes.youtube_youtube"})
+	pageHeader, ok := scopeMetadata.AppearanceAttributes["page-header"].(map[string]interface{})
+	c.Check(ok, Equals, true)
+	c.Check(pageHeader["background"], Equals, "color:///#ffffff")
+	c.Check(pageHeader["divider-color"], Equals, "#b31217")
+	c.Check(pageHeader["logo"], Equals, "unity-scope-youtube/build/src/logo.png")
+	
+	c.Check(scopeMetadata.Keywords, DeepEquals, []string{"music","video"})
+}

=== modified file 'shim.cpp'
--- shim.cpp	2015-03-19 14:23:43 +0000
+++ shim.cpp	2015-05-21 14:58:20 +0000
@@ -51,3 +51,18 @@
     destroy_ptr<const Category>(data);
 }
 
+_ScopeMetadata** list_registry_scopes_metadata(_ScopeBase *scope, int *n_scopes) {
+    ScopeBase *s = reinterpret_cast<ScopeBase*>(scope);
+    auto registry = s->registry();
+    auto scopes = registry->list();
+
+    *n_scopes = scopes.size();
+
+    _ScopeMetadata** ret_data = reinterpret_cast<_ScopeMetadata**>(calloc(*n_scopes, sizeof(_ScopeMetadata*)));
+    int i = 0;
+    for( auto item: scopes ) {
+        ret_data[i++] = reinterpret_cast<_ScopeMetadata*>(new ScopeMetadata(item.second));
+    }
+
+    return ret_data;
+}

=== modified file 'shim.h'
--- shim.h	2015-04-17 09:54:06 +0000
+++ shim.h	2015-05-21 14:58:20 +0000
@@ -16,6 +16,7 @@
 typedef struct _Result _CategorisedResult;
 typedef struct _SearchMetadata _SearchMetadata;
 typedef struct _ActionMetadata _ActionMetadata;
+typedef struct _ScopeMetadata _ScopeMetadata;
 typedef struct _QueryMetadata _QueryMetadata;
 typedef struct _ColumnLayout _ColumnLayout;
 typedef void _ScopeBase;
@@ -32,6 +33,7 @@
 char *scope_base_cache_directory(_ScopeBase *scope);
 char *scope_base_tmp_directory(_ScopeBase *scope);
 void *scope_base_settings(_ScopeBase *scope, int *length);
+_ScopeMetadata **list_registry_scopes_metadata(_ScopeBase *scope, int *n_scopes);
 
 /* SearchReply objects */
 void init_search_reply_ptr(SharedPtrData dest, SharedPtrData src);
@@ -118,6 +120,10 @@
 void *action_metadata_get_hint(_ActionMetadata *metadata, void *key, int *data_length, char **error);
 void *action_metadata_get_hints(_ActionMetadata *metadata, int *length);
 
+/* ScopeMetadata objects */
+void destroy_scope_metadata_ptr(_ScopeMetadata *metadata);
+char *get_scope_metadata_serialized(_ScopeMetadata *metadata);
+
 /* ActivationResponse objects */
 void activation_response_init_status(_ActivationResponse *response, int status);
 void activation_response_init_query(_ActivationResponse *response, _CannedQuery *query);

=== modified file 'tests/goscope/goscope.go'
--- tests/goscope/goscope.go	2015-03-30 10:11:02 +0000
+++ tests/goscope/goscope.go	2015-05-21 14:58:20 +0000
@@ -3,6 +3,7 @@
 import (
 	"launchpad.net/go-unityscopes/v2"
 	"log"
+	"fmt"
 )
 
 const searchCategoryTemplate = `{
@@ -107,6 +108,17 @@
 
 func (s *MyScope) SetScopeBase(base *scopes.ScopeBase) {
 	s.base = base
+	
+	// THIS IS JUST A TEST ON THE STDOUT
+	listScopes := s.base.ListRegistryScopes()
+	fmt.Print("LIST SCOPES ****************************************************************\n")
+	for k := range listScopes {
+		fmt.Print(k)
+		fmt.Print("\n")
+		fmt.Print(*listScopes[k])
+		fmt.Print("\n")
+	}
+	fmt.Print("LIST SCOPES ****************************************************************\n")
 }
 
 // RESULTS *********************************************************************

=== modified file 'unityscope.go'
--- unityscope.go	2015-03-25 10:18:56 +0000
+++ unityscope.go	2015-05-21 14:58:20 +0000
@@ -164,6 +164,28 @@
 	return C.GoString(dir)
 }
 
+// ListRegistryScopes lists all the scopes existing in the registry
+func (b *ScopeBase) ListRegistryScopes() map[string]*ScopeMetadata {
+	var nb_scopes C.int
+	var c_array **C._ScopeMetadata = C.list_registry_scopes_metadata(b.b, &nb_scopes)
+	defer C.free(unsafe.Pointer(c_array))
+
+	length := int(nb_scopes)
+	// create a very big slice and then slice it to the number of scopes metadata
+	slice := (*[1 << 27]*C._ScopeMetadata)(unsafe.Pointer(c_array))[:length:length]
+	var scopesList = make(map[string]*ScopeMetadata)
+
+	for i := 0; i < length; i++ {
+		json_data := C.get_scope_metadata_serialized(slice[i])
+		defer C.free(unsafe.Pointer(json_data))
+
+		metadata := makeScopeMetadata(slice[i], C.GoString(json_data))
+		scopesList[metadata.ScopeId] = metadata
+	}
+
+	return scopesList
+}
+
 // Settings returns the scope's settings.  The settings will be
 // decoded into the given value according to the same rules used by
 // json.Unmarshal().