[meta.user] New "tags" type with auto-completion and special display. Expose meta definitions directly in plugin params and load them statically. We should remove the other way to pass the meta_fields values.

cdujeu · cdujeu · commit 6ced8262a41b · 2015-04-01T23:02:45.000+02:00
diff --git a/core/src/plugins/meta.user/class.MetaCellRenderer.js b/core/src/plugins/meta.user/class.MetaCellRenderer.js
@@ -18,7 +18,8 @@
  * The latest code can be found at <http://pyd.io/>.
  * Description : Static class for renderers
  */
-Class.create("MetaCellRenderer", {	
+Class.create("MetaCellRenderer", {
+
 	initialize: function(){
 		this.cssList = new Hash({
 			'low': {cssClass:'meta_low', label:MessageHash['meta.user.4'], sortValue:'5'},
@@ -38,8 +39,36 @@ Class.create("MetaCellRenderer", {
 			});
 			head.insert(cssNode);
 		}
+
 	},
 
+    staticGetMetaConfigs: function(){
+        if(pydio && pydio.user && pydio.user.activeRepository && MetaCellRenderer.configsCache && MetaCellRenderer.configsCache.get(pydio.user.activeRepository )){
+            return MetaCellRenderer.configsCache.get(pydio.user.activeRepository);
+        }
+        var configs = $H();
+        try{
+            configs = $H(pydio.getPluginConfigs("meta.user").get("meta_definitions").evalJSON());
+            configs.each(function(pair){
+                var type = pair.value.type;
+                if(type == 'choice' && pair.value.data){
+                    var values = {};
+                    $A(pair.value.data.split(",")).each(function(keyLabel){
+                        var parts = keyLabel.split("|");
+                        values[parts[0]] = parts[1];
+                    });
+                    pair.value.data = values;
+                }
+            });
+        }catch(e){
+        }
+        if(pydio && pydio.user && pydio.user.activeRepository){
+            if(!MetaCellRenderer.configsCache) MetaCellRenderer.configsCache = $H();
+            MetaCellRenderer.configsCache.set(pydio.user.activeRepository, configs);
+        }
+        return configs;
+    },
+
     /* SELECTORS */
     selectorsFilter : function(element, ajxpNode, type, metadataDef, ajxpNodeObject){
         if(!metadataDef) return;
@@ -70,21 +99,33 @@ Class.create("MetaCellRenderer", {
                 }
                 element.writeAttribute("data-sorter_value", nodeMetaValue);
             }else{
+                if(element.down('.text_label') && values[element.down('.text_label').innerHTML.stripTags()]){
+                    element.down('.text_label').update(values[element.down('.text_label').innerHTML.stripTags()]);
+                }
                 element.writeAttribute("data-"+metadataDef.attributeName+"-sorter_value", nodeMetaValue);
             }
         }
     },
 
     formPanelSelectorFilter: function(formElement, form){
-        if(MetaCellRenderer.staticMetadataCache && MetaCellRenderer.staticMetadataCache.get(formElement.name)){
-            var selectorValues  = MetaCellRenderer.staticMetadataCache.get(formElement.name);
+        var selectorValues;
+        try{
+            selectorValues = MetaCellRenderer.staticMetadataCache.get(formElement.name);
+        }catch(e){}
+        if(!selectorValues){
+            var definitions = MetaCellRenderer.prototype.staticGetMetaConfigs();
+            selectorValues = definitions.get(formElement.name).data;
+        }
+        if(selectorValues){
             if(!selectorValues) return;
             var value = formElement.getValue();
-            var select = new Element('select', {name: formElement.name,style:'width:56%;height:24px;'});
+            var select = new Element('select', {name: formElement.name, className:'select_meta_selector'});
+            select.insert(new Element("option", {value:''}).update(''));
             $H(selectorValues).each(function(pair){
                 select.insert(new Element("option", {value:pair.key}).update(pair.value));
                 if(value) select.setValue(value);
             });
+            if(formElement.id) select.id = formElement.id;
             formElement.replace(select);
         }
     },
@@ -205,7 +246,7 @@ Class.create("MetaCellRenderer", {
         }
 	},
 	
-	infoPanelModifier : function(htmlElement){
+	infoPanelModifier : function(htmlElement, ajxpNode){
         var obj = new MetaCellRenderer();
         htmlElement.select('[data-metatype]').each(function(td){
             var metaType = td.readAttribute("data-metatype");
@@ -233,6 +274,10 @@ Class.create("MetaCellRenderer", {
                         }
                     }
                 break;
+                case "tags":
+                    var value = td.innerHTML.strip();
+                    this.displayTagsAsBlocks(td, value, ajxpNode);
+                break;
                 case "text":
                 case "string":
                 case "textarea":
@@ -372,5 +417,116 @@ Class.create("MetaCellRenderer", {
 		var cont = new Element('textarea', {name:formElement.name,style:'float: left;width: 161px;border-radius: 3px;padding: 2px;height:100px;'});
 		cont.innerHTML = formElement.value;
 		formElement.replace(cont);
-	}
+	},
+
+
+    formPanelTags: function(formElement, form){
+
+        var fieldName = formElement.name;
+        var completer = new MetaTagsCompleter(formElement, fieldName);
+
+    },
+
+    displayTagsAsBlocks: function(element, value, ajxpNode){
+        if(!value) return;
+        var values = $A(value.split(",")).invoke("strip");
+        element.update('');
+        values.each(function(v){
+            var tag = new Element('span', {className:"meta_user_tag_block"}).update(v + " <span class='icon-remove' style='cursor: pointer;'></span>");
+            element.insert(tag);
+            var remove = tag.down(".icon-remove");
+            remove.observe("click", function(){
+                var conn = new Connexion();
+                conn.setParameters($H({
+                    get_action:"edit_user_meta",
+                    file: ajxpNode.getPath(),
+                    tags: values.without(v).join(", ")
+                }));
+                conn.onComplete = function(transport){
+                    pydio.actionBar.parseXmlMessage(transport.responseXML);
+                };
+                conn.sendAsync();
+            });
+        });
+    }
+
+});
+
+/**
+ * Encapsulation of the Prototype Autocompleter for Pydio purposes.
+ * Should be ported for local provides
+ */
+Class.create("MetaTagsCompleter", Autocompleter.Base, {
+
+    valuesLoaded: null,
+    /**
+     * Constructor
+     * @param element HTMLElement
+     * @param fieldName String
+     */
+    initialize: function(element, fieldName) {
+        var update = "meta_tags_complete_"+fieldName;
+        if(Object.isString(update) && !$(update)){
+            $$('body')[0].insert(new Element('div', {
+                id:update,
+                className:"autocomplete",
+                style:"position:absolute;z-index:100000;margin-top: 0;"
+            }));
+        }
+        var options = {fieldName: fieldName, tokens: ","};
+        this.baseInitialize(element, update, options);
+        this.options.defaultParams = this.options.parameters || null;
+        this.options.minChars	   = 0;
+
+        element.observe("click", function(){
+            this.activate();
+        }.bind(this));
+    },
+
+    valuesToChoices: function(search){
+        var currentValues = $A(this.element.getValue().split(",")).invoke("strip");
+        var choices = "";
+        if(search && this.valuesLoaded.indexOf(search)) {
+            choices += "<li>"+search+"</li>";
+        }
+        this.valuesLoaded.each(function(v){
+            if(v.indexOf(search) === 0 && currentValues.indexOf(v) === -1){
+                choices += "<li>"+v+"</li>";
+            }
+        }.bind(this));
+        choices = "<ul>"+ choices + "</ul>";
+        this.updateChoices(choices);
+        return choices;
+    },
+
+    /**
+     * Gets the choices
+     */
+    getUpdatedChoices: function() {
+        this.startIndicator();
+        var value = this.getToken().strip();
+        if(this.valuesLoaded){
+            var choices = this.valuesToChoices(value);
+            this.updateChoices(choices);
+            return choices;
+        }
+
+        var connexion = new Connexion();
+        connexion.setParameters($H({get_action:'meta_user_list_tags'}));
+        if(this.options.fieldName){
+            connexion.addParameter("meta_field_name", this.options.fieldName);
+        }
+        connexion.onComplete = function(transport){
+            this.valuesLoaded = $A(transport.responseJSON);
+            var choices = this.valuesToChoices(value);
+            this.updateChoices(choices);
+            this.stopIndicator();
+            return choices;
+        }.bind(this);
+
+        connexion.sendAsync();
+
+        return "";
+    }
+
 });
diff --git a/core/src/plugins/meta.user/class.UserMetaManager.php b/core/src/plugins/meta.user/class.UserMetaManager.php
@@ -55,6 +55,10 @@ public function initMeta($accessDriver)
 
         //$messages = ConfService::getMessages();
         $def = $this->getMetaDefinition();
+        foreach($def as $k => &$d){
+            if(isSet($this->fieldsAdditionalData[$k])) $d["data"] = $this->fieldsAdditionalData[$k];
+        }
+        $this->exposeConfigInManifest("meta_definitions", json_encode($def));
         if(!isSet($this->options["meta_visibility"])) $visibilities = array("visible");
         else $visibilities = explode(",", $this->options["meta_visibility"]);
         $editButton = '';
@@ -112,8 +116,11 @@ public function initMeta($accessDriver)
                     $col->setAttribute("modifier", "MetaCellRenderer.prototype.selectorsFilter");
                     $col->setAttribute("sortType", "CellSorterValue");
                     $col->setAttribute("metaAdditional", $this->fieldsAdditionalData[$key]);
-                    $searchablesRenderers[$key] = "MetaCellRenderer.prototype.selectorsFilter";
+                    $searchablesRenderers[$key] = "MetaCellRenderer.prototype.formPanelSelectorFilter";
                     break;
+                case "tags":
+                    $searchables[$key] = $label;
+                    $searchablesRenderers[$key] = "MetaCellRenderer.prototype.formPanelTags";
                 default:
                     break;
             }
@@ -238,6 +245,9 @@ public function editMeta($actionName, $httpVars, $fileVars)
             foreach ($def as $key => $data) {
                 if (isSet($httpVars[$key])) {
                     $newValues[$key] = AJXP_Utils::decodeSecureMagic($httpVars[$key]);
+                    if($data["type"] == "tags"){
+                        $this->updateTags(AJXP_Utils::decodeSecureMagic($httpVars[$key]));
+                    }
                 } else {
                     if (!isset($original)) {
                         $original = $ajxpNode->retrieveMetadata("users_meta", false, AJXP_METADATA_SCOPE_GLOBAL);
@@ -348,4 +358,30 @@ public function updateMetaLocation($oldNode, $newNode = null, $copy = false)
         }
     }
 
+    public function listTags($actionName, &$httpVars, &$fileVars){
+
+        HTMLWriter::charsetHeader("application/json");
+        $tags = $this->loadTags();
+        if(empty($tags)) $tags = array();
+        echo json_encode($tags);
+
+    }
+
+    protected function loadTags(){
+        $store = ConfService::getConfStorageImpl();
+        if(!is_a($store, "sqlConfDriver")) return array();
+        $data = array();
+        $store->simpleStoreGet("meta_user_tags", ConfService::getRepository()->getId(), "serial", $data);
+        return $data;
+    }
+
+    protected function updateTags($tagString){
+        $store = ConfService::getConfStorageImpl();
+        if(!is_a($store, "sqlConfDriver")) return;
+        $tags = $this->loadTags();
+        $tags = array_merge($tags, array_map("trim", explode(",", $tagString)));
+        $tags = array_unique($tags);
+        $store->simpleStoreSet("meta_user_tags", ConfService::getRepository()->getId(), array_values($tags), "serial");
+    }
+
 }
diff --git a/core/src/plugins/meta.user/manifest.xml b/core/src/plugins/meta.user/manifest.xml
@@ -12,7 +12,7 @@
 		<!--<param name="meta_file_name" type="string" label="CONF_MESSAGE[Meta File]" description="CONF_MESSAGE[Hidden file used inside folders to save meta data]" mandatory="true" default=".ajxp_meta"/>-->
 		<param name="meta_fields" type="string" replicationGroup="group1" label="CONF_MESSAGE[Field ID]" description="CONF_MESSAGE[Id of fiels, use standard characters here.]" mandatory="true" default="comment_field"/>
 		<param name="meta_labels" type="string" replicationGroup="group1" label="CONF_MESSAGE[Label]" description="CONF_MESSAGE[Label of the field, human friendly]" mandatory="true" default="My Comments"/>
-		<param name="meta_types" type="select" choices="string|CONF_MESSAGE[Short text],textarea|CONF_MESSAGE[Long text],creator|CONF_MESSAGE[Created by...],updater|CONF_MESSAGE[Last updated by...],stars_rate|CONF_MESSAGE[Stars Rating],css_label|CONF_MESSAGE[Color labels],choice|CONF_MESSAGE[Selection (set choices in Additional Info)]" replicationGroup="group1" label="CONF_MESSAGE[Field Type]" description="CONF_MESSAGE[Type of field]" mandatory="true" default="string"/>
+		<param name="meta_types" type="select" choices="string|CONF_MESSAGE[Short text],textarea|CONF_MESSAGE[Long text],creator|CONF_MESSAGE[Created by...],updater|CONF_MESSAGE[Last updated by...],stars_rate|CONF_MESSAGE[Stars Rating],css_label|CONF_MESSAGE[Color labels],choice|CONF_MESSAGE[Selection (set choices in Additional Info)],tags|CONF_MESSAGE[Tags (extensible sets of values)]" replicationGroup="group1" label="CONF_MESSAGE[Field Type]" description="CONF_MESSAGE[Type of field]" mandatory="true" default="string"/>
 		<param name="meta_visibility" type="select" replicationGroup="group1" label="CONF_MESSAGE[Column visibility]" description="CONF_MESSAGE[Set default visibility.]" mandatory="true" default="visible" choices="visible|CONF_MESSAGE[Visible],hidden|CONF_MESSAGE[Hidden]"/>
 		<param name="meta_additional" type="string" replicationGroup="group1" label="CONF_MESSAGE[Additional info]" description="CONF_MESSAGE[Depending on the field type. Currently used for selection only]" mandatory="false"/>
 	</server_settings>
@@ -24,7 +24,7 @@
 		<client_configs>
 			<template_part ajxpId="search_container" ajxpClass="SearchEngine" ajxpOptions="{}"/>
 			<template_part ajxpId="search_container" ajxpClass="SearchEngine" ajxpOptions='{"toggleResultsVisibility":"search_results_cont", "fitMarginBottom":20}' theme="vision"/>
-			<template_part ajxpId="search_container" ajxpClass="SearchEngine" ajxpOptions='{"toggleResultsVisibility":"search_results_cont", "searchChooserAsResultsHeader":true, "openSearchInput":"true", "toggleResultsFitTo":"cpane_tabs", "fitMarginBottom":0, "toggleResultsOffsetRight":0, "toggleResultsOffsetTop":0, "detailThumbSize":24}' theme="orbit"/>
+			<template_part ajxpId="search_container" ajxpClass="SearchEngine" ajxpOptions='{"toggleResultsVisibility":"search_results_cont", "searchChooserAsResultsHeader":true, "openSearchInput":"true", "openSearchStickLeftTo":"topPane", "toggleResultsFitTo":"cpane_tabs", "fitMarginBottom":0, "toggleResultsOffsetRight":0, "toggleResultsOffsetTop":0, "detailThumbSize":24}' theme="orbit"/>
 			<component_config className="FilesList">
 				<columns><!-- Dynamically generated by the plugin  --></columns>
 			</component_config>
@@ -35,6 +35,11 @@
 			</component_config>
 		</client_configs>
 		<actions>
+            <action name="meta_user_list_tags">
+                <processing>
+                    <serverCallback methodName="listTags"/>
+                </processing>
+            </action>
             <action name="edit_user_meta_mass">
                 <gui text="meta.user.1" title="meta.user.1" src="meta_user/ICON_SIZE/tag.png" iconClass="icon-tags" hasAccessKey="false">
                     <context selection="true" dir="" recycle="hidden"
@@ -85,6 +90,8 @@
 									MetaCellRenderer.prototype.formTextarea(element, form);
 								}else if(fieldType == 'choice'){
 								    MetaCellRenderer.prototype.formPanelSelectorFilter(element, form);
+                                }else if(fieldType == 'tags'){
+                                    MetaCellRenderer.prototype.formPanelTags(element, form);
 								}else if(fieldType == 'updater' || fieldType == 'creator'){
 								    element.disabled = true;
 								}
