urbit/pkg/arvo/app/group-store.hoon

::  group-store: Store groups of ships
::
::    group-store stores groups of ships, so that resources in other apps can be
::    associated with a group. The current model of group-store rolls
::    permissions and invites inside this store for simplicity reasons, although
::    these should be prised apart in a future revision of group store.
::
::
::    ## Scry paths
::
::    /y/groups:
::      A listing of the current groups
::    /y/groups/[group-id]/tag-queries:
::      A listing of the tag queries for a group
::    /x/groups/[group-id]:
::      The group itself
::    /x/groups/[group-id]/join/[ship]:
::      A flag indicated if the ship is permitted to join
::
::    ## Subscription paths
::
::    /groups:
::      A stream of the current updates to the state, sending the initial state
::      upon subscribe.
::
::    ##  Pokes
::
::    %group-action:
::      Modify the group. Further documented in /sur/group-store.hoon
::
::
/-  *group
/+  store=group-store, default-agent, verb, dbug
|%
+$  card  card:agent:gall
::
+$  versioned-state
  $%  state-zero
      state-one
  ==
::
+$  state-zero
  $:  %0
      * :: =groups
  ==
::
::
+$  state-one
  $:  %1
      =groups
  ==
::
+$  diff
  $%  [%group-update update:store]
      [%group-initial groups]
  ==
--
::
=|  state-one
=*  state  -
::
%-  agent:dbug
%+  verb  |
^-  agent:gall
=<
  |_  =bowl:gall
  +*  this        .
      group-core  +>
      gc          ~(. group-core bowl)
      def         ~(. (default-agent this %|) bowl)
  ::
  ++  on-init  on-init:def
  ++  on-save   !>(state)
  ++  on-load
    |=  =old=vase
    =/  old  !<(versioned-state old-vase)
    ?.  ?=(%1 -.old)
      `this
    `this(state old)
  ::
  ++  on-poke
    |=  [=mark =vase]
    ^-  (quip card _this)
    ?>  (team:title our.bowl src.bowl)
    =^  cards  state
      ?:  ?=(?(%group-update %group-action) mark)
        (poke-group-update:gc !<(update:store vase))
      (on-poke:def mark vase)
    [cards this]
  ::
  ++  on-watch
    |=  =path
    ^-  (quip card _this)
    ?>  (team:title our.bowl src.bowl)
    ?>  ?=([%groups ~] path)
    :_  this
    [%give %fact ~ %group-update !>([%initial groups])]~
  ::
  ++  on-leave  on-leave:def
  ::
  ++  on-peek
    |=  =path
    ^-  (unit (unit cage))
    ?+  path  (on-peek:def path)
        [%x %groups @ @ ~]
      =/  group-id
        (group-id:de-path:store t.t.path)
      ?~  group-id  ~
      ``noun+!>((peek-group u.group-id))
       [%x %groups @ @ %join @ ~]
      =/  group-id
        (group-id:de-path:store t.t.path)
      =/  =ship
        (slav %p i.t.t.t.t.t.path)
      ?~  group-id  ~
      ``noun+!>((peek-group-join u.group-id ship))
    ::
       [%x %groups @ @ %role @ ~]
      =/  group-id
        (group-id:de-path:store t.t.path)
      ?~  group-id  ~
      =/  =ship
        (slav %p i.t.t.t.t.t.path)
      ``noun+!>((peek-group-role u.group-id ship))
    ==
  ::
  ++  on-agent  on-agent:def
  ++  on-arvo   on-arvo:def
  ++  on-fail   on-fail:def
  --
::
|_  bol=bowl:gall
++  ship-rank
  |=  =ship
  ^-  rank
  =/  size
    (met 3 ship)
  ?:  (lte size 2)
    %0
  ?:  (lte size 4)
    %1
  ?:  (lte size 8)
    %2
  %3
++  peek-group
  |=  =group-id
  ^-  (unit group)
  (~(get by groups) group-id)

++  peek-group-join
  |=  [=group-id =ship]
  =/  =group
    (~(gut by groups) group-id *group)
  =*  policy  policy.group
  ?-  -.policy
      %invite
    |((~(has in pending.policy) ship) (~(has in members.group) ship))
      %open
    &(!(~(has in banned.policy) ship) (~(has in ranks.policy) (ship-rank ship)))
  ==
++  peek-group-role
  |=  [=group-id =ship]
  =/  =group
    (~(got by groups) group-id)
  =*  policy  policy.group
  =*  tag-queries  tag-queries.group
  =/  admins=(set ^ship)
    (~(gut by tag-queries) %admin ~)
  ?:  (~(has in admins) ship)
    `%admin
  =/  mods
    (~(gut by tag-queries) %moderator ~)
  ?:  (~(has in mods) ship)
    `%moderator
  =/  janitors
    (~(gut by tag-queries) %janitor ~)
  ?.  (~(has in janitors) ship)
    ~
  `%janitor
::
++  poke-group-update
  |=  =update:store
  ^-  (quip card _state)
  ?>  (team:title our.bol src.bol)
  |^
  ?-  -.update
      %add-group       (add-group +.update)
      %add-members     (add-members +.update)
      %remove-members  (remove-members +.update)
      %add-tag         (add-tag +.update)
      %remove-tag      (remove-tag +.update)
      %change-policy   (change-policy +.update)
      %remove-group    (remove-group +.update)
      %initial-group   (initial-group +.update)
      %initial         [~ state]
  ==
  ::  +add-group: add group to store
  ::
  ::    always include ship in own groups, no-op if group already exists
  ::
  ++  add-group
    |=  [=group-id =policy]
    ^-  (quip card _state)
    ?:  (~(has by groups) group-id)
      [~ state]
    =|  =group
    =.  members.group
      (~(put in members.group) our.bol)
    =.  policy.group   policy
    =.  groups
      (~(put by groups) group-id group)
    :_  state
    (send-diff %add-group group-id policy)
  ::  +add-members: add members to group
  ::
  ::    no-op if group does not exist
  ::
  ++  add-members
    |=  [=group-id new-ships=(set ship) tags=(set tag)]
    ^-  (quip card _state)
    ?.  (~(has by groups) group-id)
      [~ state]
    =/  =group  (~(got by groups) group-id)
    =.  members.group  (~(uni in members.group) new-ships)
    =.  tag-queries.group
      (merge-tags tag-queries.group new-ships tags)
    =*  policy  policy.group
    =.  policy
      ?.  ?=(%invite -.policy)
        policy
      =.  pending.policy
        (~(dif in pending.policy) new-ships)
      policy
    =.  groups
      (~(put by groups) group-id group)
    :_  state
    (send-diff %add-members group-id new-ships tags)
  ::  +remove-members: remove members from group
  ::
  ::    no-op if group does not exist
  ::
  ::
  ++  remove-members
    |=  [=group-id ships=(set ship)]
    ^-  (quip card _state)
    ?.  (~(has by groups) group-id)
      [~ state]
    =/  =group
      (~(got by groups) group-id)
    =.  members.group
      (~(dif in members.group) ships)
    =.  tag-queries.group
      (remove-tags group ships)
    =.  groups
      (~(put by groups) group-id group)
    :_   state
    (send-diff %remove-members group-id ships)
  ::  +add-tag: add tag to ships
  ::
  ::    no-op if group does not exist
  ::    crash if ships are not in group (is this right?)
  ::
  ++  add-tag
    |=  [=group-id =tag ships=(set ship)]
    ^-  (quip card _state)
    ?:  (~(has by groups) group-id)
      [~ state]
    =/  =group
      (~(got by groups) group-id)
    ?>  ?=(~ (~(dif in ships) members.group))
    =.  tag-queries.group
      (merge-tags tag-queries.group ships (sy tag ~))
    =.  groups
      (~(put by groups) group-id group)
    :_  state
    (send-diff %add-tag group-id tag ships)
  ::  +remove-tag: remove tag from ships
  ::
  ::    no-op if group does not exist
  ::    crash if ships are not in group or tag does not exist (is this right?)
  ::
  ++  remove-tag
    |=  [=group-id =tag ships=(set ship)]
    ^-  (quip card _state)
    ?:  (~(has by groups) group-id)
      [~ state]
    =/  =group
      (~(got by groups) group-id)
    ?>  ?&  ?=(~ (~(dif in ships) members.group))
            (~(has by tag-queries.group) tag)
        ==
    =/  tag-query
      (~(got by tag-queries.group) tag)
    =.  tag-query
      (~(dif in tag-query) ships)
    =.  tag-queries.group
      (~(put by tag-queries.group) tag tag-query)
    :_  state
    (send-diff %remove-tag group-id tag ships)
  ::  initial-group: initialize foreign group
  ::
  ++  initial-group
    |=  [=group-id =group]
    ^-  (quip card _state)
    =.  groups
      (~(put by groups) group-id group)
    :_  state
    (send-diff %initial-group group-id group)
  ::  +change-policy: modify group access control
  ::
  ::    If the change will kick members, then send a separate
  ::    %remove-members diff after the %change-policy diff
  ++  change-policy
    |=  [=group-id =diff:policy]
    ^-  (quip card _state)
    ?.  (~(has by groups) group-id)
      [~ state]
    =/  =group
      (~(got by groups) group-id)
    |^
    =^  cards  group
      ?-  -.diff
        %allow-ranks     (allow-ranks +.diff)
        %ban-ranks       (ban-ranks +.diff)
        %allow-ships     (allow-ships +.diff)
        %ban-ships       (ban-ships +.diff)
        %add-invites     (add-invites +.diff)
        %remove-invites  (remove-invites +.diff)
        %replace         (replace +.diff)
      ==
    =.  groups
      (~(put by groups) group-id group)
    :_  state
    %+  weld
      (send-diff %change-policy group-id diff)
    cards
    ::
    ++  allow-ranks
      |=  ranks=(set rank)
      ^-  (quip card _group)
      ?>  ?=(%open -.policy.group)
      =.  ranks.policy.group
        (~(uni in ranks.policy.group) ranks)
      `group
    ::
    ++  ban-ranks
      |=  ranks=(set rank)
      ^-  (quip card _group)
      ?>  ?=(%open -.policy.group)
      =.  ranks.policy.group
        (~(dif in ranks.policy.group) ranks)
      `group
    ::
    ++  allow-ships
      |=  ships=(set ship)
      ^-  (quip card _group)
      ?>  ?=(%open -.policy.group)
      =.  banned.policy.group
        (~(dif in banned.policy.group) ships)
      `group
    ::
    ++  ban-ships
      |=  ships=(set ship)
      ^-  (quip card _group)
      ?>  ?=(%open -.policy.group)
      =.  banned.policy.group
        (~(uni in banned.policy.group) ships)
      =/  to-remove=(set ship)
        (~(int in members.group) banned.policy.group)
      :-  ~[(poke-us %remove-members group-id to-remove)]
      group
    ::
    ++  add-invites
      |=  ships=(set ship)
      ^-  (quip card _group)
      ?>  ?=(%invite -.policy.group)
      =.  pending.policy.group
        (~(uni in pending.policy.group) ships)
      `group
    ::
    ++  remove-invites
      |=  ships=(set ship)
      ^-  (quip card _group)
      ?>  ?=(%invite -.policy.group)
      =.  pending.policy.group
        (~(uni in pending.policy.group) ships)
      `group
    ++  replace
      |=  =policy
      ^-  (quip card _group)
      =.  policy.group
        policy
      `group
    --
  ::  +remove-group: remove group from store
  ::
  ::    no-op if group does not exist
  ++  remove-group
    |=  [=group-id ~]
    ^-  (quip card _state)
    ?.  (~(has by groups) group-id)
      `state
    =.  groups
      (~(del by groups) group-id)
    :_  state
    (send-diff %remove-group group-id ~)
  ::
  --
++  remove-tags
  |=  [=group ships=(set ship)]
  ^-  tag-quries
  %-   malt
  %+  spin
      ~(tap by tag-queries.group)
    tag-queries.group
  |=  [=tag tagged=(set ship)]
  :-  tag
  (~(dif in tagged) ships)
::
++  poke-us
  |=  =action:store
  ^-  card
  [%pass / %agent [our.bol %group-store] %poke %group-action !>(action)]
::  +send-diff: update subscribers of new state
::
::    We only allow subscriptions on /groups
::    so just give the fact there.
++  send-diff
  |=  =update:store
  ^-  (list card)
  [%give %fact ~[/groups] %group-update !>(update)]~
::
--