mirror of
https://github.com/gristlabs/grist-core.git
synced 2024-10-27 20:44:07 +00:00
accd640078
Summary: This makes a `user.SessionID` value available in information about the user, for use with trigger formulas and granular access rules. The ID should be constant within a browser session for anonymous user. For logged in users it simply reflects their user id. This ID makes it possible to write access rules and trigger formulas that allow different anonymous users to create, view, and edit their own records in a document. For example, you could have a brain-storming document for puns, and allow anyone to add to it (without logging in), letting people edit their own records, but not showing the records to others until they are approved by a moderator. Without something like this, we could only let anonymous people add one field of a record, and not have a secure way to let them edit that field or others in the same record. Also adds a `user.IsLoggedIn` flag in passing. Test Plan: Added a test, updated tests. The test added is a mini-moderation doc, don't use it for real because it allows users to edit their entries after a moderator has approved them. Reviewers: georgegevoian Reviewed By: georgegevoian Subscribers: dsagal Differential Revision: https://phab.getgrist.com/D3273
66 lines
2.0 KiB
Python
66 lines
2.0 KiB
Python
"""
|
|
This module contains a class for creating a User containing
|
|
basic user info and optional, user-defined attributes that reference
|
|
user attribute tables.
|
|
|
|
A User has the same API as the 'user' variable from
|
|
access rules. Currently, its primary purpose is to expose
|
|
user info to trigger formulas, so that they can reference info
|
|
about the current user.
|
|
|
|
The 'data' parameter represents a dictionary containing at least
|
|
the following fields:
|
|
|
|
- Access: string or None
|
|
- UserID: integer or None
|
|
- Email: string or None
|
|
- Name: string or None
|
|
- Origin: string or None
|
|
- LinkKey: dictionary
|
|
- SessionID: string or None
|
|
- IsLoggedIn: boolean
|
|
|
|
Additional keys may be included, which may have a value that is
|
|
either None or of type tuple with the following shape:
|
|
|
|
[table_id, row_id]
|
|
|
|
The first element is the id (name) of the user attribute table, and the
|
|
second element is the id of the row that matched based on the
|
|
user attribute definition.
|
|
|
|
See 'GranularAccess.ts' for the Node equivalent that
|
|
serializes the user information found in 'data'.
|
|
"""
|
|
import six
|
|
|
|
class User(object):
|
|
"""
|
|
User containing user info and optional attributes.
|
|
|
|
Setting 'is_sample' will substitute user attributes with
|
|
typed equivalents, for use by autocompletion.
|
|
"""
|
|
def __init__(self, data, tables, is_sample=False):
|
|
for attr in ('Access', 'UserID', 'Email', 'Name', 'Origin', 'SessionID',
|
|
'IsLoggedIn'):
|
|
setattr(self, attr, data[attr])
|
|
|
|
self.LinkKey = LinkKey(data['LinkKey'])
|
|
|
|
for name, value in six.iteritems(data):
|
|
if hasattr(self, name) or not value:
|
|
continue
|
|
table_name, row_id = value
|
|
table = tables.get(table_name)
|
|
if not table:
|
|
continue
|
|
# TODO: Investigate use of __dir__ in Record for type information
|
|
record = table.sample_record if is_sample else table.get_record(row_id)
|
|
setattr(self, name, record)
|
|
|
|
class LinkKey(object):
|
|
def __init__(self, data):
|
|
for name, value in six.iteritems(data):
|
|
setattr(self, name, value)
|