ufkc7e3d
/
budibase
forked from tsai/budibase
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
Browse Source

Removing all reference to 'pages' in server source code, now to look at builder.

gh-pages
mike12345567 6 years ago
parent
90a8435641
commit
8ff9635cd1
5 changed files with 330 additions and 309 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 98
      packages/server/src/api/controllers/application.js
  2. 36
      packages/server/src/automations/automationUtils.js
  3. 22
      packages/server/src/automations/thread.js
  4. 410
      packages/server/src/constants/layouts.js
  5. 73
      packages/server/src/utilities/mustache.js

98
packages/server/src/api/controllers/application.js
View File

@ -19,28 +19,45 @@ const {
generateLayoutID, generateLayoutID,
generateScreenID, generateScreenID,
} = require("../../db/utils") } = require("../../db/utils")
const { BUILTIN_LEVEL_IDS } = require("../../utilities/security/accessLevels") const {
BUILTIN_LEVEL_IDS,
AccessController,
} = require("../../utilities/security/accessLevels")
const { const {
downloadExtractComponentLibraries, downloadExtractComponentLibraries,
} = require("../../utilities/createAppPackage") } = require("../../utilities/createAppPackage")
const { MAIN, UNAUTHENTICATED, LayoutTypes } = require("../../constants/layouts") const { BASE_LAYOUTS } = require("../../constants/layouts")
const { HOME_SCREEN } = require("../../constants/screens") const { HOME_SCREEN } = require("../../constants/screens")
const { cloneDeep } = require("lodash/fp") const { cloneDeep } = require("lodash/fp")
const { recurseMustache } = require("../../utilities/mustache")
const APP_PREFIX = DocumentTypes.APP + SEPARATOR const APP_PREFIX = DocumentTypes.APP + SEPARATOR
// utility function, need to do away with this // utility function, need to do away with this
async function getMainAndUnauthPage(db) { async function getLayouts(db) {
let pages = await db.allDocs( return (
getLayoutParams(null, { await db.allDocs(
include_docs: true, getLayoutParams(null, {
}) include_docs: true,
) })
pages = pages.rows.map(row => row.doc) )
).rows.map(row => row.doc)
}
async function getScreens(db) {
return (
await db.allDocs(
getScreenParams(null, {
include_docs: true,
})
)
).rows.map(row => row.doc)
}
const mainPage = pages.find(page => page.name === LayoutTypes.MAIN) function getUserAccessLevelId(ctx) {
const unauthPage = pages.find(page => page.name === LayoutTypes.UNAUTHENTICATED) return !ctx.user.accessLevel || !ctx.user.accessLevel._id
return { mainPage, unauthPage } ? BUILTIN_LEVEL_IDS.PUBLIC
: ctx.user.accessLevel._id
} }
async function createInstance(template) { async function createInstance(template) {
@ -85,25 +102,16 @@ exports.fetch = async function(ctx) {
exports.fetchAppDefinition = async function(ctx) { exports.fetchAppDefinition = async function(ctx) {
const db = new CouchDB(ctx.params.appId) const db = new CouchDB(ctx.params.appId)
// TODO: need to get rid of pages here, they shouldn't be needed anymore const layouts = await getLayouts(db)
const { mainPage, unauthPage } = await getMainAndUnauthPage(db) const userAccessLevelId = getUserAccessLevelId(ctx)
const userAccessLevelId = const accessController = new AccessController(ctx.params.appId)
!ctx.user.accessLevel || !ctx.user.accessLevel._id const screens = accessController.checkScreensAccess(
? BUILTIN_LEVEL_IDS.PUBLIC await getScreens(db),
: ctx.user.accessLevel._id userAccessLevelId
const correctPage = )
userAccessLevelId === BUILTIN_LEVEL_IDS.PUBLIC ? unauthPage : mainPage
const screens = (
await db.allDocs(
getScreenParams(correctPage._id, {
include_docs: true,
})
)
).rows.map(row => row.doc)
// TODO: need to handle access control here, limit screens to user access level
ctx.body = { ctx.body = {
page: correctPage, layouts,
screens: screens, screens,
libraries: ["@budibase/standard-components"], libraries: ["@budibase/standard-components"],
} }
} }
@ -111,16 +119,14 @@ exports.fetchAppDefinition = async function(ctx) {
exports.fetchAppPackage = async function(ctx) { exports.fetchAppPackage = async function(ctx) {
const db = new CouchDB(ctx.params.appId) const db = new CouchDB(ctx.params.appId)
const application = await db.get(ctx.params.appId) const application = await db.get(ctx.params.appId)
const layouts = await getLayouts(db)
const screens = await getScreens(db)
const { mainPage, unauthPage } = await getMainAndUnauthPage(db)
ctx.body = { ctx.body = {
application, application,
pages: { screens,
main: mainPage, layouts,
unauthenticated: unauthPage,
},
} }
await setBuilderToken(ctx, ctx.params.appId, application.version) await setBuilderToken(ctx, ctx.params.appId, application.version)
} }
@ -193,18 +199,18 @@ const createEmptyAppPackage = async (ctx, app) => {
fs.mkdirpSync(newAppFolder) fs.mkdirpSync(newAppFolder)
const mainPage = cloneDeep(MAIN) const bulkDocs = []
mainPage._id = generateLayoutID() for (let layout of BASE_LAYOUTS) {
mainPage.title = app.name const cloned = cloneDeep(layout)
cloned._id = generateLayoutID()
const unauthPage = cloneDeep(UNAUTHENTICATED) cloned.title = app.name
unauthPage._id = generateLayoutID() bulkDocs.push(recurseMustache(cloned, app))
unauthPage.title = app.name }
unauthPage.props._children[0].title = `Log in to ${app.name}`
const homeScreen = cloneDeep(HOME_SCREEN) const homeScreen = cloneDeep(HOME_SCREEN)
homeScreen._id = generateScreenID(mainPage._id) homeScreen._id = generateScreenID()
await db.bulkDocs([mainPage, unauthPage, homeScreen]) bulkDocs.push(homeScreen)
await db.bulkDocs(bulkDocs)
await compileStaticAssets(app._id) await compileStaticAssets(app._id)
return newAppFolder return newAppFolder

36
packages/server/src/automations/automationUtils.js
View File

@ -1,41 +1,5 @@
const CouchDB = require("../db") const CouchDB = require("../db")
/**
* When running mustache statements to execute on the context of the automation it possible user's may input mustache
* in a few different forms, some of which are invalid but are logically valid. An example of this would be the mustache
* statement "{{steps[0].revision}}" here it is obvious the user is attempting to access an array or object using array
* like operators. These are not supported by Mustache and therefore the statement will fail. This function will clean up
* the mustache statement so it instead reads as "{{steps.0.revision}}" which is valid and will work. It may also be expanded
* to include any other mustache statement cleanup that has been deemed necessary for the system.
*
* @param {string} string The string which *may* contain mustache statements, it is OK if it does not contain any.
* @returns {string} The string that was input with cleaned up mustache statements as required.
*/
module.exports.cleanMustache = string => {
let charToReplace = {
"[": ".",
"]": "",
}
let regex = new RegExp(/{{[^}}]*}}/g)
let matches = string.match(regex)
if (matches == null) {
return string
}
for (let match of matches) {
let baseIdx = string.indexOf(match)
for (let key of Object.keys(charToReplace)) {
let idxChar = match.indexOf(key)
if (idxChar !== -1) {
string =
string.slice(baseIdx, baseIdx + idxChar) +
charToReplace[key] +
string.slice(baseIdx + idxChar + 1)
}
}
}
return string
}
/** /**
* When values are input to the system generally they will be of type string as this is required for mustache. This can * When values are input to the system generally they will be of type string as this is required for mustache. This can
* generate some odd scenarios as the Schema of the automation requires a number but the builder might supply a string * generate some odd scenarios as the Schema of the automation requires a number but the builder might supply a string

22
packages/server/src/automations/thread.js
View File

@ -1,30 +1,10 @@
const handlebars = require("handlebars")
const actions = require("./actions") const actions = require("./actions")
const logic = require("./logic") const logic = require("./logic")
const automationUtils = require("./automationUtils") const automationUtils = require("./automationUtils")
const { recurseMustache } = require("../utilities/mustache")
handlebars.registerHelper("object", value => {
return new handlebars.SafeString(JSON.stringify(value))
})
const FILTER_STEP_ID = logic.BUILTIN_DEFINITIONS.FILTER.stepId const FILTER_STEP_ID = logic.BUILTIN_DEFINITIONS.FILTER.stepId
function recurseMustache(inputs, context) {
for (let key of Object.keys(inputs)) {
let val = inputs[key]
if (typeof val === "string") {
val = automationUtils.cleanMustache(inputs[key])
const template = handlebars.compile(val)
inputs[key] = template(context)
}
// this covers objects and arrays
else if (typeof val === "object") {
inputs[key] = recurseMustache(inputs[key], context)
}
}
return inputs
}
/** /**
* The automation orchestrator is a class responsible for executing automations. * The automation orchestrator is a class responsible for executing automations.
* It handles the context of the automation and makes sure each step gets the correct * It handles the context of the automation and makes sure each step gets the correct

410
packages/server/src/constants/layouts.js
View File

@ -1,221 +1,219 @@
const LayoutTypes = { const BASE_LAYOUTS = [
MAIN: "main", {
UNAUTHENTICATED: "unauthenticated", componentLibraries: ["@budibase/standard-components"],
} title: "{{ name }}",
favicon: "./_shared/favicon.png",
const MAIN = { stylesheets: [],
componentLibraries: ["@budibase/standard-components"], name: "Main",
title: "{{ name }}", props: {
favicon: "./_shared/favicon.png", _id: "private-master-root",
stylesheets: [], _component: "@budibase/standard-components/container",
name: LayoutTypes.MAIN, _children: [
props: { {
_id: "private-master-root", _id: "c74f07266980c4b6eafc33e2a6caa783d",
_component: "@budibase/standard-components/container", _component: "@budibase/standard-components/container",
_children: [ _styles: {
{ normal: {
_id: "c74f07266980c4b6eafc33e2a6caa783d", display: "flex",
_component: "@budibase/standard-components/container", "flex-direction": "row",
_styles: { "justify-content": "flex-start",
normal: { "align-items": "flex-start",
display: "flex", background: "#fff",
"flex-direction": "row", width: "100%",
"justify-content": "flex-start", "box-shadow": "0 1px 2px 0 rgba(0, 0, 0, 0.05)",
"align-items": "flex-start", },
background: "#fff", hover: {},
width: "100%", active: {},
"box-shadow": "0 1px 2px 0 rgba(0, 0, 0, 0.05)", selected: {},
}, },
hover: {}, _code: "",
active: {}, className: "",
selected: {}, onLoad: [],
}, type: "div",
_code: "", _appId: "inst_app_80b_f158d4057d2c4bedb0042d42fda8abaf",
className: "", _instanceName: "Header",
onLoad: [], _children: [
type: "div", {
_appId: "inst_app_80b_f158d4057d2c4bedb0042d42fda8abaf", _id: "49e0e519-9e5e-4127-885a-ee6a0a49e2c1",
_instanceName: "Header", _component: "@budibase/standard-components/Navigation",
_children: [ _styles: {
{ normal: {
_id: "49e0e519-9e5e-4127-885a-ee6a0a49e2c1", "max-width": "1400px",
_component: "@budibase/standard-components/Navigation", "margin-left": "auto",
_styles: { "margin-right": "auto",
normal: { padding: "20px",
"max-width": "1400px", color: "#757575",
"margin-left": "auto", "font-weight": "400",
"margin-right": "auto", "font-size": "16px",
padding: "20px", flex: "1 1 auto",
color: "#757575", },
"font-weight": "400", hover: {},
"font-size": "16px", active: {},
flex: "1 1 auto", selected: {},
}, },
hover: {}, _code: "",
active: {}, logoUrl:
selected: {}, "https://d33wubrfki0l68.cloudfront.net/aac32159d7207b5085e74a7ef67afbb7027786c5/2b1fd/img/logo/bb-emblem.svg",
}, title: "",
_code: "", backgroundColor: "",
logoUrl: color: "",
"https://d33wubrfki0l68.cloudfront.net/aac32159d7207b5085e74a7ef67afbb7027786c5/2b1fd/img/logo/bb-emblem.svg", borderWidth: "",
title: "", borderColor: "",
backgroundColor: "", borderStyle: "",
color: "", _appId: "inst_cf8ace4_69efc0d72e6f443db2d4c902c14d9394",
borderWidth: "", _instanceName: "Navigation",
borderColor: "", _children: [
borderStyle: "", {
_appId: "inst_cf8ace4_69efc0d72e6f443db2d4c902c14d9394", _id: "48b35328-4c91-4343-a6a3-1a1fd77b3386",
_instanceName: "Navigation", _component: "@budibase/standard-components/link",
_children: [ _styles: {
{ normal: {
_id: "48b35328-4c91-4343-a6a3-1a1fd77b3386", "font-family": "Inter",
_component: "@budibase/standard-components/link", "font-weight": "500",
_styles: { color: "#000000",
normal: { "text-decoration-line": "none",
"font-family": "Inter", "font-size": "16px",
"font-weight": "500", },
color: "#000000", hover: {
"text-decoration-line": "none", color: "#4285f4",
"font-size": "16px", },
active: {},
selected: {},
}, },
hover: { _code: "",
color: "#4285f4", url: "/",
}, openInNewTab: false,
active: {}, text: "Home",
selected: {}, color: "",
hoverColor: "",
underline: false,
fontSize: "",
fontFamily: "initial",
_appId: "inst_cf8ace4_69efc0d72e6f443db2d4c902c14d9394",
_instanceName: "Home Link",
_children: [],
}, },
_code: "", ],
url: "/", },
openInNewTab: false, ],
text: "Home", },
color: "", {
hoverColor: "", _id: "7fcf11e4-6f5b-4085-8e0d-9f3d44c98967",
underline: false, _component: "##builtin/screenslot",
fontSize: "", _styles: {
fontFamily: "initial", normal: {
_appId: "inst_cf8ace4_69efc0d72e6f443db2d4c902c14d9394", flex: "1 1 auto",
_instanceName: "Home Link", display: "flex",
_children: [], "flex-direction": "column",
}, "justify-content": "flex-start",
], "align-items": "stretch",
}, "max-width": "100%",
], "margin-left": "20px",
}, "margin-right": "20px",
{ width: "1400px",
_id: "7fcf11e4-6f5b-4085-8e0d-9f3d44c98967", padding: "20px",
_component: "##builtin/screenslot", },
_styles: { hover: {},
normal: { active: {},
flex: "1 1 auto", selected: {},
display: "flex",
"flex-direction": "column",
"justify-content": "flex-start",
"align-items": "stretch",
"max-width": "100%",
"margin-left": "20px",
"margin-right": "20px",
width: "1400px",
padding: "20px",
}, },
hover: {}, _code: "",
active: {}, _children: [],
selected: {},
}, },
_code: "", ],
_children: [], type: "div",
}, _styles: {
], active: {},
type: "div", hover: {},
_styles: { normal: {
active: {}, display: "flex",
hover: {}, "flex-direction": "column",
normal: { "align-items": "center",
display: "flex", "justify-content": "flex-start",
"flex-direction": "column", "margin-right": "auto",
"align-items": "center", "margin-left": "auto",
"justify-content": "flex-start", "min-height": "100%",
"margin-right": "auto", "background-image":
"margin-left": "auto", "linear-gradient(135deg, rgba(252,215,212,1) 20%, rgba(207,218,255,1) 100%);",
"min-height": "100%", },
"background-image": selected: {},
"linear-gradient(135deg, rgba(252,215,212,1) 20%, rgba(207,218,255,1) 100%);",
}, },
selected: {}, _code: "",
className: "",
onLoad: [],
}, },
_code: "",
className: "",
onLoad: [],
}, },
} {
componentLibraries: ["@budibase/standard-components"],
const UNAUTHENTICATED = { title: "{{ name }}",
componentLibraries: ["@budibase/standard-components"], favicon: "./_shared/favicon.png",
title: "{{ name }}", stylesheets: [],
favicon: "./_shared/favicon.png", name: "Unauthenticated",
stylesheets: [], props: {
name: LayoutTypes.UNAUTHENTICATED, _id: "public-master-root",
props: { _component: "@budibase/standard-components/container",
_id: "public-master-root", _children: [
_component: "@budibase/standard-components/container", {
_children: [ _id: "686c252d-dbf2-4e28-9078-414ba4719759",
{ _component: "@budibase/standard-components/login",
_id: "686c252d-dbf2-4e28-9078-414ba4719759", _styles: {
_component: "@budibase/standard-components/login", normal: {
_styles: { padding: "64px",
normal: { background: "rgba(255, 255, 255, 0.4)",
padding: "64px", "border-radius": "0.5rem",
background: "rgba(255, 255, 255, 0.4)", "margin-top": "0px",
"border-radius": "0.5rem", margin: "0px",
"margin-top": "0px", "line-height": "1",
margin: "0px", "box-shadow":
"line-height": "1", "0 20px 25px -5px rgba(0, 0, 0, 0.1), 0 10px 10px -5px rgba(0, 0, 0, 0.04)",
"box-shadow": "font-size": "16px",
"0 20px 25px -5px rgba(0, 0, 0, 0.1), 0 10px 10px -5px rgba(0, 0, 0, 0.04)", "font-family": "Inter",
"font-size": "16px", flex: "0 1 auto",
"font-family": "Inter", transform: "0",
flex: "0 1 auto", },
transform: "0", hover: {},
active: {},
selected: {},
}, },
hover: {}, _code: "",
active: {}, loginRedirect: "",
selected: {}, usernameLabel: "Username",
passwordLabel: "Password",
loginButtonLabel: "Login",
buttonClass: "",
_instanceName: "Login",
inputClass: "",
_children: [],
title: "Log in to {{ name }}",
buttonText: "Log In",
logo:
"https://d33wubrfki0l68.cloudfront.net/aac32159d7207b5085e74a7ef67afbb7027786c5/2b1fd/img/logo/bb-emblem.svg",
}, },
_code: "", ],
loginRedirect: "", type: "div",
usernameLabel: "Username", _styles: {
passwordLabel: "Password", active: {},
loginButtonLabel: "Login", hover: {},
buttonClass: "", normal: {
_instanceName: "Login", display: "flex",
inputClass: "", "flex-direction": "column",
_children: [], "align-items": "center",
title: "Log in to {{ name }}", "justify-content": "center",
buttonText: "Log In", "margin-right": "auto",
logo: "margin-left": "auto",
"https://d33wubrfki0l68.cloudfront.net/aac32159d7207b5085e74a7ef67afbb7027786c5/2b1fd/img/logo/bb-emblem.svg", "min-height": "100%",
}, "background-image":
], "linear-gradient(135deg, rgba(252,215,212,1) 20%, rgba(207,218,255,1) 100%);",
type: "div", },
_styles: { selected: {},
active: {},
hover: {},
normal: {
display: "flex",
"flex-direction": "column",
"align-items": "center",
"justify-content": "center",
"margin-right": "auto",
"margin-left": "auto",
"min-height": "100%",
"background-image":
"linear-gradient(135deg, rgba(252,215,212,1) 20%, rgba(207,218,255,1) 100%);",
}, },
selected: {}, _code: "",
className: "",
onLoad: [],
}, },
_code: "",
className: "",
onLoad: [],
}, },
} ]
module.exports = { MAIN, UNAUTHENTICATED, LayoutTypes } module.exports = {
BASE_LAYOUTS,
}

73
packages/server/src/utilities/mustache.js
View File

@ -0,0 +1,73 @@
const handlebars = require("handlebars")
handlebars.registerHelper("object", value => {
return new handlebars.SafeString(JSON.stringify(value))
})
/**
* When running mustache statements to execute on the context of the automation it possible user's may input mustache
* in a few different forms, some of which are invalid but are logically valid. An example of this would be the mustache
* statement "{{steps[0].revision}}" here it is obvious the user is attempting to access an array or object using array
* like operators. These are not supported by Mustache and therefore the statement will fail. This function will clean up
* the mustache statement so it instead reads as "{{steps.0.revision}}" which is valid and will work. It may also be expanded
* to include any other mustache statement cleanup that has been deemed necessary for the system.
*
* @param {string} string The string which *may* contain mustache statements, it is OK if it does not contain any.
* @returns {string} The string that was input with cleaned up mustache statements as required.
*/
function cleanMustache(string) {
let charToReplace = {
"[": ".",
"]": "",
}
let regex = new RegExp(/{{[^}}]*}}/g)
let matches = string.match(regex)
if (matches == null) {
return string
}
for (let match of matches) {
let baseIdx = string.indexOf(match)
for (let key of Object.keys(charToReplace)) {
let idxChar = match.indexOf(key)
if (idxChar !== -1) {
string =
string.slice(baseIdx, baseIdx + idxChar) +
charToReplace[key] +
string.slice(baseIdx + idxChar + 1)
}
}
}
return string
}
/**
* Given an input object this will recurse through all props to try and update
* any handlebars/mustache statements within.
* @param {object|array} inputs The input structure which is to be recursed, it is important to note that
* if the structure contains any cycles then this will fail.
* @param {object} context The context that handlebars should fill data from.
* @returns {object|array} The structure input, as fully updated as possible.
*/
function recurseMustache(inputs, context) {
// JSON stringify will fail if there are any cycles, stops infinite recursion
try {
JSON.stringify(inputs)
} catch (err) {
throw "Unable to process inputs to JSON, cannot recurse"
}
for (let key of Object.keys(inputs)) {
let val = inputs[key]
if (typeof val === "string") {
val = cleanMustache(inputs[key])
const template = handlebars.compile(val)
inputs[key] = template(context)
}
// this covers objects and arrays
else if (typeof val === "object") {
inputs[key] = recurseMustache(inputs[key], context)
}
}
return inputs
}
exports.recurseMustache = recurseMustache
Write Preview
Loading…
Cancel
Save