[rygel/wip/basic-management: 78/95] core: Add BasicManagement test history limits

[Jussi Kukkonen <jussik src gnome org>]

commit 4a6c9bbc620f95f65826516992ce954a813ebd1f
Author: Jussi Kukkonen <jussi kukkonen intel com>
Date:   Fri Jun 7 15:28:07 2013 +0300

    core: Add BasicManagement test history limits
    
    - Add a per test type (ping/nslokkup/traceroute) information storage
    limit.
    - Limit is set to 10 test per type of test by default.
    - When the limit is reached, the oldest test of the same type is removed.
    - Per test types linked lists of test ids are used to know which
    test of a given type is the oldest.
    - If the test to be removed is active, it is cancelled and also removed
    from the active tests list.

 src/librygel-core/rygel-basic-management-test.vala |    5 +
 src/librygel-core/rygel-basic-management.vala      |  109 +++++++++-----------
 2 files changed, 52 insertions(+), 62 deletions(-)
---
diff --git a/src/librygel-core/rygel-basic-management-test.vala 
b/src/librygel-core/rygel-basic-management-test.vala
index 0d7b79c..ff264a4 100644
--- a/src/librygel-core/rygel-basic-management-test.vala
+++ b/src/librygel-core/rygel-basic-management-test.vala
@@ -209,6 +209,11 @@ internal abstract class Rygel.BasicManagementTest : Object {
         return true;
     }
 
+    public bool is_active () {
+        return this.execution_state == ExecutionState.REQUESTED ||
+               this.execution_state == ExecutionState.IN_PROGRESS;
+    }
+
     public async virtual void execute () throws BasicManagementTestError {
         if (this.execution_state != ExecutionState.REQUESTED)
             throw new BasicManagementTestError.NOT_POSSIBLE
diff --git a/src/librygel-core/rygel-basic-management.vala b/src/librygel-core/rygel-basic-management.vala
index 7436b00..ba31b85 100644
--- a/src/librygel-core/rygel-basic-management.vala
+++ b/src/librygel-core/rygel-basic-management.vala
@@ -34,18 +34,19 @@ public class Rygel.BasicManagement : Service {
                         "urn:schemas-upnp-org:service:BasicManagement:2";
     public const string DESCRIPTION_PATH = "xml/BasicManagement2.xml";
 
-    private HashMap<string, BasicManagementTest> tests_map;
-    private HashMap<string, BasicManagementTest> active_tests_map;
+    public uint max_history_size { get; set; default = 10;}
 
-    private static uint current_id = 0;
+    private HashMap<string, BasicManagementTest> tests_map;
+    private HashMap<string, LinkedList<string>> test_ids_by_type;
 
+    private uint current_id;
     protected string device_status;
 
     public override void constructed () {
         base.constructed ();
 
         this.tests_map = new HashMap<string, BasicManagementTest> ();
-        this.active_tests_map = new HashMap<string, BasicManagementTest> ();
+        this.test_ids_by_type = new HashMap<string, LinkedList> ();
 
         var now = TimeVal ();
         now.tv_usec = 0;
@@ -83,55 +84,58 @@ public class Rygel.BasicManagement : Service {
                                         (this.cancel_test_cb);
     }
 
-    private string create_test_ids_list (bool active) {
+    private string create_test_ids_list (bool active_only) {
         string test_ids_list = "";
-        HashMap<string, BasicManagementTest> test_map;
 
-        if (active) {
-            test_map = this.active_tests_map;
-        } else {
-            test_map = this.tests_map;
-        }
+        foreach (var test in this.tests_map.values) {
+            if (active_only && !test.is_active())
+                continue;
 
-        foreach (string key in test_map.keys) {
-            if (test_ids_list == "") {
-                test_ids_list = key;
-            } else {
-                test_ids_list += "," + key;
-            }
+            if (test_ids_list.length > 0)
+                test_ids_list += ",";
+
+            test_ids_list += test.id;
         }
 
         return test_ids_list;
     }
 
-    private void update_test_ids_lists (BasicManagementTest bm_test) {
-        BasicManagementTest.ExecutionState execution_state = bm_test.execution_state;
+    private string add_test (BasicManagementTest test) {
+        this.current_id++;
+        test.id = this.current_id.to_string ();
 
-        if ((execution_state == BasicManagementTest.ExecutionState.REQUESTED) ||
-            (execution_state == BasicManagementTest.ExecutionState.IN_PROGRESS)) {
+        this.tests_map.set (test.id, test);
 
-            this.tests_map.set (bm_test.id, bm_test);
-            this.notify ("TestIDs", typeof (string),
-                         create_test_ids_list (false));
+        /* Add test to a list of ids of that method type (creating the list if needed) */
+        LinkedList<string> type_test_ids = this.test_ids_by_type[test.method_type];
+        if (type_test_ids == null) {
+            type_test_ids = new LinkedList<string> ();
+            this.test_ids_by_type.set (test.method_type, type_test_ids);
+        }
+        type_test_ids.add (test.id);
 
-            this.active_tests_map.set (bm_test.id, bm_test);
-            this.notify ("ActiveTestIDs", typeof (string),
-                         create_test_ids_list (true));
-        } else if ((execution_state == BasicManagementTest.ExecutionState.CANCELED) ||
-                   (execution_state == BasicManagementTest.ExecutionState.COMPLETED)) {
-            this.active_tests_map.unset (bm_test.id);
-            this.notify ("ActiveTestIDs", typeof (string),
-                         create_test_ids_list (true));
+        /* remove oldest of same type, if needed */
+        if (type_test_ids.size > this.max_history_size) {
+            var old_id = type_test_ids.poll_head ();
+
+            try {
+                this.tests_map[old_id].cancel();
+            } catch (BasicManagementTestError e) {
+                /* test was not running, not a problem */
+            }
+            this.tests_map.unset (old_id);
         }
+
+        this.notify ("TestIDs", typeof (string),
+                     create_test_ids_list (false));
+        this.notify ("ActiveTestIDs", typeof (string),
+                     create_test_ids_list (true));
+        return test.id;
     }
 
     private void add_test_and_return_action (BasicManagementTest bm_test,
                                              ServiceAction action) {
-        current_id++;
-
-        bm_test.id = current_id.to_string ();
-
-        update_test_ids_lists (bm_test);
+        var id = this.add_test (bm_test);
 
         /* TODO: decide if test should really execute now */
         bm_test.execute.begin ((obj,res) => {
@@ -140,36 +144,17 @@ public class Rygel.BasicManagement : Service {
             } catch (BasicManagementTestError e) {
                 /* already executing */
             }
-
-            update_test_ids_lists (bm_test);
+            this.notify ("ActiveTestIDs", typeof (string),
+                         create_test_ids_list (true));
         });
 
         action.set ("TestID",
                         typeof (string),
-                        bm_test.id);
+                        id);
 
         action.return ();
     }
 
-/*
-    /// TODO: NOT USED YET
-    private void remove_test (BasicManagementTest bm_test) {
-        bm_test
-        if (this.tests_map.unset (bm_test.id) == true) {
-            this.notify ("TestIDs", typeof (string),
-                         create_test_ids_list (false));
-        }
-
-        if (this.active_tests_map.unset (bm_test.id) == true) {
-            this.cancel();
-
-            this.notify ("ActiveTestIDs", typeof (string),
-                         create_test_ids_list (true));
-        }
-    }
-*/
-
-    // Error out if 'TestID' is wrong
     private bool ensure_test_exists (ServiceAction action,
                                      out BasicManagementTest bm_test) {
 
@@ -200,9 +185,7 @@ public class Rygel.BasicManagement : Service {
             action.return_error (708, _("Invalid Test State"));
 
             return false;
-        } else if ((action.get_name() == "CancelTest") &&
-                   ((bm_test.execution_state == BasicManagementTest.ExecutionState.CANCELED) ||
-                    (bm_test.execution_state == BasicManagementTest.ExecutionState.COMPLETED))) {
+        } else if ((action.get_name() == "CancelTest") && !bm_test.is_active()) {
             /// TestID is valid but the test can't be canceled
             action.return_error (709, _("State Precludes Cancel"));
 
@@ -551,6 +534,8 @@ public class Rygel.BasicManagement : Service {
         } catch (BasicManagementTestError e) {
             warning ("Canceled test was not running\n");
         }
+        /* ActiveTestIDs notification is handled by 
+         * the tests' execute callback */
 
         action.return ();
     }