mirror of
https://github.com/gristlabs/grist-core.git
synced 2024-09-28 11:10:46 +00:00
d0d3d3d0c9
Summary: This diff discounts indirect changes for access control purposes. A UserAction that updates a cell A, which in turn causes changes in other dependent cells, will be considered a change to cell A for access control purposes. The `engine.apply_user_actions` method now returns a `direct` array, with a boolean for each `stored` action, set to `true` if the action is attributed to the user or `false` if it is attributed to the engine. `GranularAccess` ignores actions attributed to the engine when checking for edit rights. Subtleties: * Removal of references to a removed row are considered direct changes. * Doesn't play well with undos as yet. An action that indirectly modifies a cell the user doesn't have rights to may succeed, but it will not be reversible. Test Plan: added tests, updated tests Reviewers: dsagal Reviewed By: dsagal Differential Revision: https://phab.getgrist.com/D2806
76 lines
3.2 KiB
TypeScript
76 lines
3.2 KiB
TypeScript
/**
|
|
* Basic definitions of types needed for ActionBundles.
|
|
* See also EncActionBundle for how these are packaged for encryption.
|
|
*/
|
|
|
|
import {DocAction, UserAction} from 'app/common/DocActions';
|
|
|
|
// Metadata about the action.
|
|
export interface ActionInfo {
|
|
time: number; // Milliseconds since epoch.
|
|
user: string;
|
|
inst: string;
|
|
desc?: string;
|
|
otherId: number;
|
|
linkId: number;
|
|
}
|
|
|
|
// Envelope contains information about recipients. In EncActionBundle, it's augmented with
|
|
// information about the symmetric key that encrypts this envelope's contents.
|
|
export interface Envelope {
|
|
recipients: string[]; // sorted array of recipient instanceIds
|
|
}
|
|
|
|
// EnvContent packages arbitrary content with the index of the envelope to which it belongs.
|
|
export type EnvContent<Content> = [number, Content];
|
|
|
|
// ActionBundle contains actions arranged into envelopes, i.e. split up by sets of recipients.
|
|
// Note that different Envelopes contain different sets of recipients (which may overlap however).
|
|
// ActionBundle is what gets encrypted/decrypted and then sent between hub and instance.
|
|
export interface ActionBundle {
|
|
actionNum: number;
|
|
actionHash: string|null; // a checksum of bundle, (not including actionHash and other parts).
|
|
parentActionHash: string|null; // a checksum of the parent action bundle, if there is one.
|
|
envelopes: Envelope[];
|
|
info: EnvContent<ActionInfo>; // Should be in the envelope addressed to all peers.
|
|
stored: Array<EnvContent<DocAction>>;
|
|
calc: Array<EnvContent<DocAction>>;
|
|
}
|
|
|
|
export function getEnvContent<Content>(items: Array<EnvContent<Content>>): Content[] {
|
|
return items.map((item) => item[1]);
|
|
}
|
|
|
|
// ======================================================================
|
|
// Types for ActionBundles used locally inside an instance.
|
|
|
|
// Local action received from the browser, that is not yet applied. It is usually one UserAction,
|
|
// but when multiple actions are sent by the browser in one call, they will form one bundle.
|
|
export interface UserActionBundle {
|
|
info: ActionInfo;
|
|
userActions: UserAction[];
|
|
}
|
|
|
|
// ActionBundle as received from the sandbox. It does not have some action metadata, but does have
|
|
// undo information and a retValue for each input UserAction. Note that it is satisfied by the
|
|
// ActionBundle structure defined in sandbox/grist/action_obj.py.
|
|
export interface SandboxActionBundle {
|
|
envelopes: Envelope[];
|
|
stored: Array<EnvContent<DocAction>>;
|
|
direct: Array<EnvContent<boolean>>;
|
|
calc: Array<EnvContent<DocAction>>;
|
|
undo: Array<EnvContent<DocAction>>; // Inverse actions for all 'stored' actions.
|
|
retValues: any[]; // Contains retValue for each of userActions.
|
|
}
|
|
|
|
// Local action that's been applied. It now has an actionNum, and includes doc actions packaged
|
|
// into envelopes, as well as undo, and userActions, which allow rebasing.
|
|
export interface LocalActionBundle extends ActionBundle {
|
|
userActions: UserAction[];
|
|
|
|
// Inverse actions for all 'stored' actions. These aren't shared and not split by envelope.
|
|
// Applying 'undo' is governed by EDIT rather than READ permissions, so we always apply all undo
|
|
// actions. (It is the result of applying 'undo' that may be addressed to different recipients).
|
|
undo: DocAction[];
|
|
}
|