mirror of
https://github.com/gristlabs/grist-core.git
synced 2024-10-27 20:44:07 +00:00
997be24a21
Summary: Bundles some new document options into a JSON column. The icon option is treated somewhat gingerly. It is intended, at least initially, to store an image thumbnail for a document as a url to hand-prepared assets (for examples and templates), so it is locked down to a particular url prefix to avoid opening the door to mischief. Test Plan: added test Reviewers: georgegevoian Reviewed By: georgegevoian Differential Revision: https://phab.getgrist.com/D2916
116 lines
4.1 KiB
TypeScript
116 lines
4.1 KiB
TypeScript
import {ApiError} from 'app/common/ApiError';
|
|
import {Role} from 'app/common/roles';
|
|
import {DocumentOptions, DocumentProperties, documentPropertyKeys, NEW_DOCUMENT_CODE} from "app/common/UserAPI";
|
|
import {nativeValues} from 'app/gen-server/lib/values';
|
|
import {Column, Entity, JoinColumn, ManyToOne, OneToMany, PrimaryColumn} from "typeorm";
|
|
import {AclRuleDoc} from "./AclRule";
|
|
import {Alias} from "./Alias";
|
|
import {Resource} from "./Resource";
|
|
import {Workspace} from "./Workspace";
|
|
|
|
// Acceptable ids for use in document urls.
|
|
const urlIdRegex = /^[-a-z0-9]+$/i;
|
|
|
|
function isValidUrlId(urlId: string) {
|
|
if (urlId === NEW_DOCUMENT_CODE) { return false; }
|
|
return urlIdRegex.exec(urlId);
|
|
}
|
|
|
|
@Entity({name: 'docs'})
|
|
export class Document extends Resource {
|
|
|
|
@PrimaryColumn()
|
|
public id: string;
|
|
|
|
@ManyToOne(type => Workspace)
|
|
@JoinColumn({name: 'workspace_id'})
|
|
public workspace: Workspace;
|
|
|
|
@OneToMany(type => AclRuleDoc, aclRule => aclRule.document)
|
|
public aclRules: AclRuleDoc[];
|
|
|
|
// Indicates whether the doc is pinned to the org it lives in.
|
|
@Column({name: 'is_pinned', default: false})
|
|
public isPinned: boolean;
|
|
|
|
// Property that may be returned when the doc is fetched to indicate the access the
|
|
// fetching user has on the doc, i.e. 'owners', 'editors', 'viewers'
|
|
public access: Role|null;
|
|
|
|
// Property set for forks, containing access the fetching user has on the trunk.
|
|
public trunkAccess?: Role|null;
|
|
|
|
// a computed column with permissions.
|
|
// {insert: false} makes sure typeorm doesn't try to put values into such
|
|
// a column when creating documents.
|
|
@Column({name: 'permissions', type: 'text', select: false, insert: false, update: false})
|
|
public permissions?: any;
|
|
|
|
@Column({name: 'url_id', type: 'text', nullable: true})
|
|
public urlId: string|null;
|
|
|
|
@Column({name: 'removed_at', type: nativeValues.dateTimeType, nullable: true})
|
|
public removedAt: Date|null;
|
|
|
|
@OneToMany(type => Alias, alias => alias.doc)
|
|
public aliases: Alias[];
|
|
|
|
@Column({name: 'options', type: nativeValues.jsonEntityType, nullable: true})
|
|
public options: DocumentOptions | null;
|
|
|
|
public checkProperties(props: any): props is Partial<DocumentProperties> {
|
|
return super.checkProperties(props, documentPropertyKeys);
|
|
}
|
|
|
|
public updateFromProperties(props: Partial<DocumentProperties>) {
|
|
super.updateFromProperties(props);
|
|
if (props.isPinned !== undefined) { this.isPinned = props.isPinned; }
|
|
if (props.urlId !== undefined) {
|
|
if (props.urlId !== null && !isValidUrlId(props.urlId)) {
|
|
throw new ApiError('invalid urlId', 400);
|
|
}
|
|
this.urlId = props.urlId;
|
|
}
|
|
if (props.options !== undefined) {
|
|
// Options are merged over the existing state - unless options
|
|
// object is set to "null", in which case the state is wiped
|
|
// completely.
|
|
if (props.options === null) {
|
|
this.options = null;
|
|
} else {
|
|
this.options = this.options || {};
|
|
if (props.options.description !== undefined) {
|
|
this.options.description = props.options.description;
|
|
}
|
|
if (props.options.openMode !== undefined) {
|
|
this.options.openMode = props.options.openMode;
|
|
}
|
|
if (props.options.icon !== undefined) {
|
|
this.options.icon = sanitizeIcon(props.options.icon);
|
|
}
|
|
// Normalize so that null equates with absence.
|
|
for (const key of Object.keys(this.options) as Array<keyof DocumentOptions>) {
|
|
if (this.options[key] === null) {
|
|
delete this.options[key];
|
|
}
|
|
}
|
|
// Normalize so that no options set equates with absense.
|
|
if (Object.keys(this.options).length === 0) {
|
|
this.options = null;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
// Check that icon points to an expected location. This will definitely
|
|
// need changing, it is just a placeholder as the icon feature is developed.
|
|
function sanitizeIcon(icon: string|null) {
|
|
if (icon === null) { return icon; }
|
|
const url = new URL(icon);
|
|
if (url.protocol !== 'https:' || url.host !== 'grist-static.com' || !url.pathname.startsWith('/icons/')) {
|
|
throw new ApiError('invalid document icon', 400);
|
|
}
|
|
return url.href;
|
|
}
|