card 1.101.2 → 1.102.0

data/tmpsets/set/mod009-permissions/all/permissions.rb

@@ -0,0 +1,240 @@
+# -*- encoding : utf-8 -*-
+class Card; module Set; class All
+# Set: All cards (Permissions)
+#
+module Permissions;
+extend Card::Set
+def self.source_location; "/Users/ezl5238/dev/decko/gem/mod/permissions/set/all/permissions.rb"; end
+module ClassMethods
+  def repair_all_permissions
+    Card.where("(read_rule_class is null or read_rule_id is null) and trash is false")
+        .each do |broken_card|
+      broken_card.include_set_modules
+      broken_card.repair_permissions!
+    end
+  end
+end
+
+def repair_permissions!
+  rule_id, rule_class = permission_rule_id_and_class :read
+  update_columns read_rule_id: rule_id, read_rule_class: rule_class
+end
+
+# ok? and ok! are public facing methods to approve one action at a time
+#
+#   fetching: if the optional :trait parameter is supplied, it is passed
+#      to fetch and the test is perfomed on the fetched card, therefore:
+#
+#      trait: :account      would fetch this card plus a tag codenamed :account
+#      trait: :roles, new: {} would initialize a new card with default ({})
+# options.
+
+def ok? action
+  @ok ||= {}
+  aok = @ok[Auth.as_id] ||= {}
+  if (cached = aok[action])
+    cached
+  else
+    aok[action] = send "ok_to_#{action}"
+  end
+end
+
+def ok! action
+  raise Card::Error::PermissionDenied, self unless ok? action
+end
+
+def who_can action
+  permission_rule_card(action).item_cards.map(&:id)
+end
+
+def anyone_can? action
+  who_can(action).include? AnyoneID
+end
+
+def direct_rule_card action
+  direct_rule_id = rule_card_id action
+  require_permission_rule! direct_rule_id, action
+  Card.quick_fetch direct_rule_id
+end
+
+def permission_rule_id action
+  if compound? && rule(action).match?(/^\[?\[?_left\]?\]?$/)
+    left_permission_rule_id action
+  else
+    rule_card_id(action)
+  end
+end
+
+def permission_rule_id_and_class action
+  [permission_rule_id(action), direct_rule_card(action).rule_class_name]
+end
+
+def left_permission_rule_id action
+  lcard = left_or_new(skip_virtual: true, skip_modules: true)
+  action = :update if action == :create && lcard.real? && lcard.action != :create
+  lcard.permission_rule_id action
+end
+
+def permission_rule_card action
+  Card.fetch permission_rule_id(action)
+end
+
+def require_permission_rule! rule_id, action
+  return if rule_id
+
+  # RULE missing.  should not be possible.
+  # generalize this to handling of all required rules
+  errors.add :permission_denied,
+             t(:permission_error_no_action_rule, action: action, name: name)
+  raise Card::Error::PermissionDenied, self
+end
+
+def rule_class_name
+  trunk.type_id == SetID ? name.trunk_name.tag : nil
+end
+
+def you_cant what
+  "You don't have permission to #{what}"
+end
+
+def deny_because why
+  @permission_errors << why if @permission_errors
+  false
+end
+
+def permitted? action
+  return false if Card.config.read_only # :read does not call #permit
+  return true if Auth.always_ok?
+
+  Auth.as_card.among? who_can(action)
+end
+
+def permit action, verb=nil
+  # not called by ok_to_read
+  if Card.config.read_only
+    deny_because "Currently in read-only mode"
+    return false
+  end
+
+  return true if permitted? action
+
+  verb ||= action.to_s
+  deny_because you_cant("#{verb} #{name.present? ? name : 'this'}")
+end
+
+def ok_to_create
+  return false unless permit :create
+  return true if simple?
+
+  %i[left right].find { |side| !ok_to_create_side side } ? false : true
+end
+
+def ok_to_create_side side
+  # left is supercard; create permissions will get checked there.
+  return true if side == :left && superleft
+
+  part_card = send side, new: {}
+  # if no card, there must be other errors
+  return true unless part_card&.new_card? && !part_card.ok?(:create)
+
+  deny_because you_cant("create #{part_card.name}")
+  false
+end
+
+def ok_to_read
+  return true if Auth.always_ok?
+
+  self.read_rule_id ||= permission_rule_id :read
+  return true if Auth.as_card.read_rules_hash[read_rule_id]
+
+  deny_because you_cant "read this"
+end
+
+def ok_to_update
+  return false unless permit(:update)
+  return true unless type_id_changed? && !permitted?(:create)
+
+  deny_because you_cant("change to this type (need create permission)")
+end
+
+def ok_to_delete
+  permit :delete
+end
+
+# don't know why we introduced this
+# but we have to preserve read rules to make
+# delete acts visible in recent changes -pk
+# event :clear_read_rule, :store, on: :delete do
+#   self.read_rule_id = self.read_rule_class = nil
+# end
+
+event :set_read_rule, :store, on: :save, changed: %i[type_id name] do
+  read_rule_id, read_rule_class = permission_rule_id_and_class(:read)
+  self.read_rule_id = read_rule_id
+  self.read_rule_class = read_rule_class
+end
+
+event :set_field_read_rules, after: :set_read_rule, on: :update, changed: :type_id do
+  each_field_as_bot(&:update_read_rule)
+end
+
+def update_field_read_rules
+  return unless type_id_changed? || read_rule_id_changed?
+
+  each_field_as_bot do |field|
+    field.update_read_rule if field.rule(:read) == "_left"
+  end
+end
+
+def each_field_as_bot &block
+  # find all cards with me as trunk and update their read_rule
+  # (because of *type plus right)
+  # skip if name is updated because will already be resaved
+  Auth.as_bot do
+    fields.each(&block)
+  end
+end
+
+def without_timestamps
+  Card.record_timestamps = false
+  yield
+ensure
+  Card.record_timestamps = true
+end
+
+event :update_read_rule do
+  without_timestamps do
+    reset_patterns # why is this needed?
+    rcard_id, rclass = permission_rule_id_and_class :read
+    # these two are just to make sure vals are correct on current object
+    self.read_rule_id = rcard_id
+    self.read_rule_class = rclass
+    Card.where(id: id).update_all read_rule_id: rcard_id, read_rule_class: rclass
+    expire :hard
+    update_field_read_rules
+  end
+end
+
+def add_to_read_rule_update_queue updates
+  @read_rule_update_queue = Array.wrap(@read_rule_update_queue).concat updates
+end
+
+event :check_permissions, :validate do
+  track_permission_errors do
+    ok? action_for_permission_check
+  end
+end
+
+def action_for_permission_check
+  commenting? ? :update : action
+end
+
+def track_permission_errors
+  @permission_errors = []
+  result = yield
+  @permission_errors.each { |msg| errors.add :permission_denied, msg }
+  @permission_errors = nil
+  result
+end
+end;end;end;end;
+# ~~ generated from /Users/ezl5238/dev/decko/gem/mod/permissions/set/all/permissions.rb ~~

data/tmpsets/set/mod009-permissions/all/update_read_rules.rb

@@ -0,0 +1,20 @@
+# -*- encoding : utf-8 -*-
+class Card; module Set; class All
+# Set: All cards (UpdateReadRules)
+#
+# FIXME: the following don't really belong here, but they have to come after
+module UpdateReadRules;
+extend Card::Set
+def self.source_location; "/Users/ezl5238/dev/decko/gem/mod/permissions/set/all/update_read_rules.rb"; end
+# the reference stuff.  we need to organize a bit!
+
+event :update_rule_cache, :finalize, when: :rule? do
+  Card::Rule.clear_rule_cache
+end
+
+event :expire_related, :finalize do
+  reset_patterns
+  structuree_names.each { |name| Director.expirees << name } if is_structure?
+end
+end;end;end;end;
+# ~~ generated from /Users/ezl5238/dev/decko/gem/mod/permissions/set/all/update_read_rules.rb ~~

data/tmpsets/set/mod009-permissions/right/create.rb

@@ -0,0 +1,10 @@
+# -*- encoding : utf-8 -*-
+class Card; module Set; class Right
+# Set: All "+Create" cards
+#
+module Create;
+extend Card::Set
+def self.source_location; "/Users/ezl5238/dev/decko/gem/mod/permissions/set/right/create.rb"; end
+include_set Abstract::Permission
+end;end;end;end;
+# ~~ generated from /Users/ezl5238/dev/decko/gem/mod/permissions/set/right/create.rb ~~

data/tmpsets/set/mod009-permissions/right/delete.rb

@@ -0,0 +1,10 @@
+# -*- encoding : utf-8 -*-
+class Card; module Set; class Right
+# Set: All "+Delete" cards
+#
+module Delete;
+extend Card::Set
+def self.source_location; "/Users/ezl5238/dev/decko/gem/mod/permissions/set/right/delete.rb"; end
+include_set Abstract::Permission
+end;end;end;end;
+# ~~ generated from /Users/ezl5238/dev/decko/gem/mod/permissions/set/right/delete.rb ~~

data/tmpsets/set/mod009-permissions/right/read.rb

@@ -0,0 +1,86 @@
+# -*- encoding : utf-8 -*-
+class Card; module Set; class Right
+# Set: All "+Read" cards
+#
+module Read;
+extend Card::Set
+def self.source_location; "/Users/ezl5238/dev/decko/gem/mod/permissions/set/right/read.rb"; end
+include Abstract::Permission
+
+format :html do include Abstract::Permission::HtmlFormat end
+
+event :cascade_read_rule, :finalize, after: :update_rule_cache, when: :rule? do
+  return unless name_is_changing? || trash_is_changing?
+
+  update_read_ruled_cards
+end
+
+def update_read_ruled_cards
+  Card::Rule.clear_read_rule_cache
+  Card.cache.reset # maybe be more surgical, just Auth.user related
+  expire # probably shouldn't be necessary,
+  # but was sometimes getting cached version when card should be in the
+  # trash.  could be related to other bugs?
+
+  processed = update_read_rules_of_set_members
+  update_cards_with_read_rule_id processed unless new?
+end
+
+def update_read_rules_of_set_members
+  return unless rule_pattern_index
+
+  each_member do |member, processed|
+    processed << member.key
+    member.update_read_rule unless member_has_overriding_rule?(member)
+  end
+end
+
+def member_has_overriding_rule? member
+  pattern_index(Card.fetch_id(member.read_rule_class)) < rule_pattern_index
+end
+
+# cards with this card as a read_rule_id
+# These may include cards that are no longer set members if the card was renamed
+# (edge case)
+def update_cards_with_read_rule_id processed
+  processed ||= ::Set.new
+  Card::Auth.as_bot do
+    Card.search(read_rule_id: id) do |card|
+      card.update_read_rule unless processed.include?(card.key)
+    end
+  end
+end
+
+def each_member &block
+  Auth.as_bot do
+    all_members.each_with_object(::Set.new, &block)
+  end
+end
+
+def all_members
+  rule_set.item_cards limit: 0
+end
+
+def rule_pattern_index
+  return if trash
+
+  @rule_pattern_index ||= pattern_index rule_set&.tag&.id
+end
+
+def pattern_index pattern_id
+  pattern_ids.index(pattern_id) || invalid_pattern_id(pattern_id)
+end
+
+def pattern_ids
+  @pattern_ids ||= set_patterns.map(&:pattern_id)
+end
+
+def invalid_pattern_id pattern_id
+  Rails.logger.info "invalid pattern id for read rule: #{pattern_id}"
+end
+
+event :process_read_rule_update_queue, :finalize do
+  left&.update_read_rule
+end
+end;end;end;end;
+# ~~ generated from /Users/ezl5238/dev/decko/gem/mod/permissions/set/right/read.rb ~~

data/tmpsets/set/mod009-permissions/right/update.rb

@@ -0,0 +1,10 @@
+# -*- encoding : utf-8 -*-
+class Card; module Set; class Right
+# Set: All "+Update" cards
+#
+module Update;
+extend Card::Set
+def self.source_location; "/Users/ezl5238/dev/decko/gem/mod/permissions/set/right/update.rb"; end
+include_set Abstract::Permission
+end;end;end;end;
+# ~~ generated from /Users/ezl5238/dev/decko/gem/mod/permissions/set/right/update.rb ~~

data/tmpsets/set/mod009-permissions/self/create.rb

@@ -0,0 +1,12 @@
+# -*- encoding : utf-8 -*-
+class Card; module Set; class Self
+# Set: The card "Create"
+#
+module Create;
+extend Card::Set
+def self.source_location; "/Users/ezl5238/dev/decko/gem/mod/permissions/set/self/create.rb"; end
+setting_opts group: :permission, position: 1, rule_type_editable: false,
+             short_help_text: "who can create cards",
+             help_text: "Who can create new cards"
+end;end;end;end;
+# ~~ generated from /Users/ezl5238/dev/decko/gem/mod/permissions/set/self/create.rb ~~

data/tmpsets/set/mod009-permissions/self/delete.rb

@@ -0,0 +1,12 @@
+# -*- encoding : utf-8 -*-
+class Card; module Set; class Self
+# Set: The card "Delete"
+#
+module Delete;
+extend Card::Set
+def self.source_location; "/Users/ezl5238/dev/decko/gem/mod/permissions/set/self/delete.rb"; end
+setting_opts group: :permission, position: 4, rule_type_editable: false,
+             short_help_text: "who can delete cards",
+             help_text: "Who can delete cards"
+end;end;end;end;
+# ~~ generated from /Users/ezl5238/dev/decko/gem/mod/permissions/set/self/delete.rb ~~

data/tmpsets/set/mod009-permissions/self/read.rb

@@ -0,0 +1,12 @@
+# -*- encoding : utf-8 -*-
+class Card; module Set; class Self
+# Set: The card "Read"
+#
+module Read;
+extend Card::Set
+def self.source_location; "/Users/ezl5238/dev/decko/gem/mod/permissions/set/self/read.rb"; end
+setting_opts group: :permission, position: 2, rule_type_editable: false,
+             short_help_text: "who can view cards",
+             help_text: "Who can view cards in the [[set]]."
+end;end;end;end;
+# ~~ generated from /Users/ezl5238/dev/decko/gem/mod/permissions/set/self/read.rb ~~

data/tmpsets/set/mod009-permissions/self/update.rb

@@ -0,0 +1,12 @@
+# -*- encoding : utf-8 -*-
+class Card; module Set; class Self
+# Set: The card "Update"
+#
+module Update;
+extend Card::Set
+def self.source_location; "/Users/ezl5238/dev/decko/gem/mod/permissions/set/self/update.rb"; end
+setting_opts group: :permission, position: 3, rule_type_editable: false,
+             short_help_text: "who can update cards",
+             help_text: "Who can update cards"
+end;end;end;end;
+# ~~ generated from /Users/ezl5238/dev/decko/gem/mod/permissions/set/self/update.rb ~~

data/tmpsets/set/mod010-account/abstract/account_field.rb

@@ -0,0 +1,31 @@
+# -*- encoding : utf-8 -*-
+class Card; module Set; class Abstract
+# Set: Abstract (AccountField)
+#
+module AccountField;
+extend Card::Set
+def self.source_location; "/Users/ezl5238/dev/decko/gem/mod/account/set/abstract/account_field.rb"; end
+delegate :accounted, to: :account_card
+
+def account_card
+  left
+end
+
+# allow account owner to update account field content
+def ok_to_update
+  return true if own_account? && !name_changed? && !type_id_changed?
+
+  super
+end
+
+# force inherit permission on create
+# (cannot be done with rule, because sets are not addressable)
+def permission_rule_id action
+  if action == :create
+    left_permission_rule_id action
+  else
+    super
+  end
+end
+end;end;end;end;
+# ~~ generated from /Users/ezl5238/dev/decko/gem/mod/account/set/abstract/account_field.rb ~~