Status picker breaks if installed by user without programming rights #177 (#205)

* Update the Status property Sheet accordingly.

* Update the task macro status parameter that also relies on the order of the statuses.

* Update the list<taskstatus> edit vm to use the script service method

* Update the task template to be up to date with the changed TaskManagerClass

* [Misc] Set the livedata filters to take the order of statuses into consideration

---------

Co-authored-by: Teodor Caras <[email protected]>

Author: Farcasut

application-task-api/src/main/java/com/xwiki/task/script/TaskScriptService.java

@@ -21,17 +21,23 @@
 
 import java.util.Collections;
 import java.util.List;
+import java.util.Objects;
+import java.util.stream.Collectors;
 
 import javax.inject.Inject;
 import javax.inject.Named;
 import javax.inject.Singleton;
 
+import org.slf4j.Logger;
 import org.xwiki.component.annotation.Component;
 import org.xwiki.job.Job;
 import org.xwiki.job.JobException;
 import org.xwiki.job.JobExecutor;
 import org.xwiki.model.reference.DocumentReference;
 import org.xwiki.model.reference.WikiReference;
+import org.xwiki.query.Query;
+import org.xwiki.query.QueryException;
+import org.xwiki.query.QueryManager;
 import org.xwiki.script.service.ScriptService;
 import org.xwiki.security.authorization.ContextualAuthorizationManager;
 import org.xwiki.security.authorization.Right;
@@ -66,6 +72,12 @@ public class TaskScriptService implements ScriptService
     @Inject
     private JobExecutor jobExecutor;
 
+    @Inject
+    private QueryManager queryManager;
+
+    @Inject
+    private Logger logger;
+
     /**
      * @return the configuration of the application.
      */
@@ -119,4 +131,23 @@ public List<DocumentReference> getPagesWithIncompleteTaskMacros()
             return Collections.emptyList();
         }
     }
+
+    /**
+     * @return a list of statuses sorted by their order property.
+     */
+    public List<String> getSortedStatuses()
+    {
+
+        try {
+            Query query = queryManager.createQuery("select prop1.value from BaseObject as obj, "
+                + "StringProperty as prop1, IntegerProperty as prop2 where obj.className='TaskManager.StatusClass' and "
+                + "obj.id=prop1.id.id and prop1.id.name='status' and obj.id=prop2.id.id and prop2.id.name='order' "
+                + "order by prop2.value", Query.HQL);
+            List<String> results = query.execute().stream().map(Objects::toString).collect(Collectors.toList());
+            return results;
+        } catch (QueryException e) {
+            logger.error("Failed to retrieve the statuses.", e);
+            throw new RuntimeException(e);
+        }
+    }
 }

application-task-api/src/main/resources/templates/html_displayer/java.util.list(com.xwiki.task.taskstatus)/edit.vm

@@ -18,17 +18,9 @@
 ## 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 ## ---------------------------------------------------------------------------
 #template("pickers_macros.vm")
-#set ($st = "select prop1.value from BaseObject as obj, StringProperty as prop1, IntegerProperty as prop2
-where obj.className='TaskManager.StatusClass'
-and obj.id=prop1.id.id
-and prop1.id.name='status'
-and obj.id=prop2.id.id
-and prop2.id.name='order'
-order by prop2.value")
-#set ($results = $services.query.hql($st).execute())
 #set ($options = [])
 #set ($translationKeyPrefix = 'TaskManager.TaskManagerClass_status_')
-#foreach ($status in $results)
+#foreach ($status in $services.task.getSortedStatuses())
   #set ($translationKey = $translationKeyPrefix + $status)
   #if ($services.localization.get($translationKey))
     #set ($label = $services.localization.render($translationKey))

application-task-api/src/main/resources/templates/html_displayer/taskstatus/edit.vm

@@ -17,21 +17,13 @@
 ## Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 ## 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 ## ---------------------------------------------------------------------------
-#set ($st = "select prop1.value from BaseObject as obj, StringProperty as prop1, IntegerProperty as prop2
-where obj.className='TaskManager.StatusClass'
-and obj.id=prop1.id.id
-and prop1.id.name='status'
-and obj.id=prop2.id.id
-and prop2.id.name='order'
-order by prop2.value")
-#set ($results = $services.query.hql($st).execute())
 <select
   #foreach ($parameter in $displayer.parameters.entrySet())
     $escapetool.xml($parameter.key)="$!escapetool.xml($parameter.value)"
   #end
 >
   #set ($translationKeyPrefix = 'TaskManager.TaskManagerClass_status_')
-  #foreach ($item in $results)
+  #foreach ($item in $services.task.getSortedStatuses())
     #set ($translationKey = $translationKeyPrefix + $item)
     #if ($services.localization.get($translationKey))
       #set ($label = $services.localization.render($translationKey))

application-task-ui/src/main/resources/TaskManager/PropertySheets/Status.xml

@@ -43,12 +43,12 @@
 #set($propertyClass = $object.getxWikiClass().get($name))
 #set($existingValue = $object.getValue('status'))
 <select size="1" name="TaskManager.TaskManagerClass_0_status" id="TaskManager.TaskManagerClass_0_status">
-#foreach($rValue in $propertyClass.mapValues.entrySet())
-  #set($key = "TaskManager.TaskManagerClass_status_$rValue.key")
+#foreach($rValue in $services.task.getSortedStatuses())
+  #set($key = "TaskManager.TaskManagerClass_status_$rValue")
   #set($translation = $services.localization.render($key))
-  <option value="$escapetool.xml($rValue.key)" #if($existingValue == $rValue.key) selected='selected' #end>
+  <option value="$escapetool.xml($rValue)" #if($existingValue == $rValue) selected='selected' #end>
     #if ($translation == $key)
-      $escapetool.xml($rValue.key)
+      $escapetool.xml($rValue)
     #else
       $escapetool.xml($translation)
     #end

application-task-ui/src/main/resources/TaskManager/TaskManagerClass.xml

@@ -357,7 +357,7 @@
       <separators/>
       <size>1</size>
       <sort>none</sort>
-      <sql>select prop1.value, prop1.value from BaseObject as obj, StringProperty as prop1, IntegerProperty as prop2 where obj.className='TaskManager.StatusClass' and obj.id=prop1.id.id and prop1.id.name='status' and obj.id=prop2.id.id and prop2.id.name='order' order by prop2.value</sql>
+      <sql/>
       <unmodifiable>0</unmodifiable>
       <validationMessage/>
       <validationRegExp/>

application-task-ui/src/main/resources/TaskManager/TaskManagerTemplate.xml

@@ -546,7 +546,7 @@
         <separators/>
         <size>1</size>
         <sort>none</sort>
-        <sql>select prop1.value, prop1.value from BaseObject as obj, StringProperty as prop1, IntegerProperty as prop2 where obj.className='TaskManager.StatusClass' and obj.id=prop1.id.id and prop1.id.name='status' and obj.id=prop2.id.id and prop2.id.name='order' order by prop2.value</sql>
+        <sql/>
         <unmodifiable>0</unmodifiable>
         <validationMessage/>
         <validationRegExp/>

application-task-ui/src/main/resources/TaskManager/TaskReportMacro.xml

@@ -294,6 +294,17 @@
 #foreach ($creatorVal in $creator.split('\s*,\s*'))
   #set ($livedataFilters = "${livedataFilters}&reporter=${creatorVal}")
 #end
+## Define the filter options for the status that need to be ordered by priority.
+#set ($statusOptions = [{"value": "", "label": $services.localization.render('livedata.filter.list.emptyLabel')}])
+#foreach($rValue in $services.task.getSortedStatuses())
+  #set($key = "TaskManager.TaskManagerClass_status_$rValue")
+  #set($translation = $services.localization.render($key))
+  #if ($translation == $key)
+    #set ($discard = $statusOptions.add({ "value": $rValue, "label": $rValue}))
+  #else
+    #set ($discard = $statusOptions.add({ "value": $rValue, "label": $translation}))
+  #end
+#end
 ## Define livedata cfg, setting all the properties to invisible by default and changing it later based on what columns the user chose.
 #set ($livedataCfg = {
   "query": {
@@ -336,7 +347,11 @@
       },
       {
         "id": "status",
-        "visible": false
+        "visible": true,
+        "filter": {
+          "id": "list",
+          "options": $statusOptions
+        }
       }
     ]
   }

application-task-ui/src/main/resources/TaskManager/WebHomeSheet.xml

@@ -44,6 +44,17 @@
 
 {{taskgantt readonly="false"/}}
 
+#set ($statusOptions = [{"value": "", "label": $services.localization.render('livedata.filter.list.emptyLabel')}])
+#foreach($rValue in $services.task.getSortedStatuses())
+  #set($key = "TaskManager.TaskManagerClass_status_$rValue")
+  #set($translation = $services.localization.render($key))
+  #if ($translation == $key)
+    #set ($discard = $statusOptions.add({ "value": $rValue, "label": $rValue}))
+  #else
+    #set ($discard = $statusOptions.add({ "value": $rValue, "label": $translation}))
+  #end
+#end
+
 {{liveData
   id="taskmanager"
   properties="name,project,status,severity,reporter,assignee,duedate,_actions"
@@ -59,6 +70,13 @@
           "id": "link",
           "propertyHref": "doc.url"
         }
+      },
+      {
+        "id": "status",
+        "filter": {
+          "id": "list",
+          "options": $jsontool.serialize($statusOptions)
+        }
       }
     ]
   }