ms-planner: Support ClientNotes

No users yet.

Signed-off-by: Ian Jackson <Ian.Jackson@eu.citrix.com>
CC: Wei Liu <wei.liu2@citrix.com>

diff --git a/README.planner b/README.planner
index daccef546ad47a921f0f36a81f4ec047e6025559..80c2506976eb4f09bd6a6628b7d493e1f27ffd51 100644 (file)
--- a/README.planner
+++ b/README.planner
@@ -286,6 +286,13 @@ Plan is:
                                                Live
                        Job     flight.job which made the allocation
 
+       ClientNotes
+               map from note key
+               to one of
+                       scalar
+                       array of values supplied by clients
+                       hash of keys/values supplied by clients
+
        * = internal to plan
        ** = computed by launder_check_plan
        + = as shown to clients
@@ -302,6 +309,12 @@ Booking list is:
                        Share           optional struct containing
                                                Type
                                                Shares
+       [ClientNotes]
+               as for Plan; merged by
+               for scalar, updating from Booking if specified
+               for array, appending Booking to Plan
+               for hash, updating individual values from Booking
+               type must not have changed!
 
 Sharing resources:
 
@@ -313,3 +326,12 @@ Bookings which do not create the share do not mention the master.
 
 Note that whether a resource is free, or simply nonexistent, is not
 represented.
+
+
+Note keys
+---------
+
+Note key name (key in ClientNotes):
+       Note value format:
+
+(none yet defined)

diff --git a/ms-planner b/ms-planner
index abf5fac2d7e93a7d374a4ad3dcc6bcf2e2c0a02e..bce6e133d671db784c90f3e7aa58d81344268407 100755 (executable)
--- a/ms-planner
+++ b/ms-planner
@@ -245,6 +245,7 @@ sub cmd_reset () {
     $plan->{Start}= time;
     $plan->{Events}= { };
     $plan->{Unprocessed}= [ ];
+    $plan->{ClientNotes}= { };
 
     my %magictask;
     foreach my $taskrefkey (qw(preparing shared)) {
@@ -415,6 +416,9 @@ sub cmd_get_plan () {
        }
        $jplan->{Events}{$reso}= \@jevts;
     }
+
+    $jplan->{ClientNotes} = $plan->{ClientNotes};
+
     print to_json($jplan),"\n" or die $!;
 }
 
@@ -529,6 +533,25 @@ sub cmd_book_resources () {
                  );
     }
 
+    my $jnotes = $jbookings->{ClientNotes} // { };
+    foreach my $k (sort keys %$jnotes) {
+       my $v = $jnotes->{$k};
+       my $newt = ref $v // '(none)';
+       if (exists $plan->{ClientNotes}{$k}) {
+           my $oldt = ref $plan->{ClientNotes}{$k} // '(none)';
+           die "$k $oldt -> $newt" unless $oldt eq $newt;
+       }
+       if (!ref $v) {
+           $plan->{ClientNotes}{$k} = $v;
+       } elsif (ref $v eq 'HASH') {
+           $plan->{ClientNotes}{$k}{$_} = $v->{$_} foreach keys %$v;
+       } elsif (ref $v eq 'ARRAY') {
+           push @{ $plan->{ClientNotes}{$_} }, @{ $jnotes->{$_} };
+       } else {
+           die "$k $newt";
+       }
+    }
+
     check_write_new_plan();
 }