affine_core 0.0.5

AFFiNE primitive core.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117

use super::{AclFacts, DocAclFacts};

#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub enum DocPreviewExposure {
  Denied,
  MetadataNoIndex,
  PublicIndexable,
}

impl DocPreviewExposure {
  pub const fn as_str(self) -> &'static str {
    match self {
      Self::Denied => "denied",
      Self::MetadataNoIndex => "metadata_no_index",
      Self::PublicIndexable => "public_indexable",
    }
  }

  pub const fn is_allowed(self) -> bool {
    !matches!(self, Self::Denied)
  }
}

#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub enum DocPreviewBasis {
  Missing,
  SharingDisabled,
  Public,
  Document,
  Workspace,
  Disabled,
}

impl DocPreviewBasis {
  pub const fn as_str(self) -> &'static str {
    match self {
      Self::Missing => "missing",
      Self::SharingDisabled => "sharing_disabled",
      Self::Public => "public",
      Self::Document => "document",
      Self::Workspace => "workspace",
      Self::Disabled => "disabled",
    }
  }
}

#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub struct DocPreviewDecision {
  pub exposure: DocPreviewExposure,
  pub basis: DocPreviewBasis,
}

pub fn evaluate_workspace_preview(facts: &AclFacts) -> DocPreviewDecision {
  if !facts.sharing_enabled {
    return DocPreviewDecision {
      exposure: DocPreviewExposure::Denied,
      basis: DocPreviewBasis::SharingDisabled,
    };
  }
  if facts.workspace_public {
    return DocPreviewDecision {
      exposure: DocPreviewExposure::PublicIndexable,
      basis: DocPreviewBasis::Public,
    };
  }
  if facts.url_preview_enabled {
    return DocPreviewDecision {
      exposure: DocPreviewExposure::MetadataNoIndex,
      basis: DocPreviewBasis::Workspace,
    };
  }
  DocPreviewDecision {
    exposure: DocPreviewExposure::Denied,
    basis: DocPreviewBasis::Disabled,
  }
}

pub fn evaluate_doc_preview(doc: Option<&DocAclFacts>, workspace_preview_enabled: bool) -> DocPreviewDecision {
  let Some(doc) = doc else {
    return DocPreviewDecision {
      exposure: DocPreviewExposure::Denied,
      basis: DocPreviewBasis::Missing,
    };
  };
  if !doc.sharing_enabled {
    return DocPreviewDecision {
      exposure: DocPreviewExposure::Denied,
      basis: DocPreviewBasis::SharingDisabled,
    };
  }
  if doc.visibility_public && matches!(doc.public_role, Some(super::DocRole::External)) {
    return DocPreviewDecision {
      exposure: DocPreviewExposure::PublicIndexable,
      basis: DocPreviewBasis::Public,
    };
  }
  if doc.preview_enabled {
    return DocPreviewDecision {
      exposure: DocPreviewExposure::MetadataNoIndex,
      basis: DocPreviewBasis::Document,
    };
  }
  if workspace_preview_enabled {
    return DocPreviewDecision {
      exposure: DocPreviewExposure::MetadataNoIndex,
      basis: DocPreviewBasis::Workspace,
    };
  }
  DocPreviewDecision {
    exposure: DocPreviewExposure::Denied,
    basis: DocPreviewBasis::Disabled,
  }
}

#[cfg(test)]
#[path = "../tests/access_control/preview/tests.rs"]
mod tests;