From c0e1c03c4e2fee818a211ef794a92359b2393a39 Mon Sep 17 00:00:00 2001 From: JamesHow1ett Date: Mon, 16 Nov 2020 16:24:13 +0200 Subject: [PATCH 1/4] re-add chenges for allowVisibleSource; add sign-off to commit Signed-off-by: JamesHow1ett --- app.js | 1 + lib/config/default.js | 1 + lib/config/environment.js | 1 + public/js/index.js | 88 ++++++++++++++++++++++++++++++++-- public/views/codimd/header.ejs | 29 ++++++++--- 5 files changed, 110 insertions(+), 10 deletions(-) diff --git a/app.js b/app.js index 4980d45d02..4b8499d78e 100644 --- a/app.js +++ b/app.js @@ -196,6 +196,7 @@ app.locals.serverURL = config.serverURL app.locals.sourceURL = config.sourceURL app.locals.allowAnonymous = config.allowAnonymous app.locals.allowAnonymousEdits = config.allowAnonymousEdits +app.locals.allowVisibleSource = config.allowVisibleSource app.locals.permission = config.permission app.locals.allowPDFExport = config.allowPDFExport app.locals.authProviders = { diff --git a/lib/config/default.js b/lib/config/default.js index 95ee1940fe..473adaa681 100644 --- a/lib/config/default.js +++ b/lib/config/default.js @@ -33,6 +33,7 @@ module.exports = { allowAnonymousEdits: true, allowAnonymousViews: true, allowFreeURL: false, + allowVisibleSource: false, forbiddenNoteIDs: ['robots.txt', 'favicon.ico', 'api'], defaultPermission: 'editable', dbURL: '', diff --git a/lib/config/environment.js b/lib/config/environment.js index 0867aecf54..0b9a821aab 100644 --- a/lib/config/environment.js +++ b/lib/config/environment.js @@ -29,6 +29,7 @@ module.exports = { allowAnonymousEdits: toBooleanConfig(process.env.CMD_ALLOW_ANONYMOUS_EDITS), allowAnonymousViews: toBooleanConfig(process.env.CMD_ALLOW_ANONYMOUS_VIEWS), allowFreeURL: toBooleanConfig(process.env.CMD_ALLOW_FREEURL), + allowVisibleSource: toBooleanConfig(process.env.CMD_ALLOW_VISIBLE_SOURCE), forbiddenNoteIDs: toArrayConfig(process.env.CMD_FORBIDDEN_NOTE_IDS), defaultPermission: process.env.CMD_DEFAULT_PERMISSION, dbURL: process.env.CMD_DB_URL, diff --git a/public/js/index.js b/public/js/index.js index c736cb7f2c..8b86af65cb 100644 --- a/public/js/index.js +++ b/public/js/index.js @@ -256,6 +256,7 @@ const statusType = { // global vars window.loaded = false +let blockSourceView = false let needRefresh = false let isDirty = false let editShown = false @@ -290,6 +291,7 @@ const lastInfo = { } let personalInfo = {} let onlineUsers = [] +let currentPermission = '' const fileTypes = { pl: 'perl', cgi: 'perl', @@ -423,6 +425,8 @@ Visibility.change(function (e, state) { // when page ready $(document).ready(function () { + if (ui.toolbar.edit.data('blockSource')) { replaceUrlToViewMode(window.location.href) } + idle.checkAway() checkResponsive() // if in smaller screen, we don't need advanced scrollbar @@ -470,12 +474,14 @@ $(document).ready(function () { // allow on all tags key.filter = function (e) { return true } key('ctrl+alt+e', function (e) { + if (blockSourceView) return changeMode(modeType.edit) }) key('ctrl+alt+v', function (e) { changeMode(modeType.view) }) key('ctrl+alt+b', function (e) { + if (blockSourceView) return changeMode(modeType.both) }) // toggle-dropdown @@ -499,6 +505,72 @@ $(window).on('error', function () { // setNeedRefresh(); }) +function checkParameter (isLogin, permission) { + if (typeof isLogin !== 'boolean' || !permission) { + throw new Error('one or more parameter is incorrect') + } + return allowVisibleSource(isLogin, permission) +} + +function replaceUrlToViewMode (url) { + const urlHasEditOrBoth = /\?edit|\?both/ + if (urlHasEditOrBoth.test(url)) { + const newUrl = url.toString().replace(urlHasEditOrBoth, '?view') + window.location.replace(newUrl) + } +} + +function allowVisibleSource (isLogin, permission) { + switch (permission) { + case 'freely': + blockSourceView = false + break + case 'editable': + case 'limited': + if (!isLogin) { + blockSourceView = true + disableModeChangeControls() + } else { + blockSourceView = false + enableModeChangeControls() + } + break + case 'locked': + case 'protected': + case 'private': + if (personalInfo.userid && window.owner && personalInfo.userid === window.owner) { + blockSourceView = false + } else { + blockSourceView = true + disableModeChangeControls() + } + break + } +} + +function disableModeChangeControls () { + ui.toolbar.edit.attr({ + disabled: 'true' + }) + ui.toolbar.both.attr({ + disabled: 'true' + }) +} + +function enableModeChangeControls () { + ui.toolbar.edit.removeAttr('disabled') + ui.toolbar.both.removeAttr('disabled') +} + +function userIsLogin (userPersonalInfo) { + return !!userPersonalInfo && !!userPersonalInfo.login +} + +function isAllowUserChangeMode () { + const isOwner = personalInfo.userid && window.owner && personalInfo.userid === window.owner + return isOwner || !blockSourceView +} + setupSyncAreas(ui.area.codemirrorScroll, ui.area.view, ui.area.markdown, editor) function autoSyncscroll () { @@ -1567,11 +1639,11 @@ function importFromUrl (url) { // mode ui.toolbar.mode.click(function () { - toggleMode() + if (isAllowUserChangeMode()) { return toggleMode() } }) // edit ui.toolbar.edit.click(function () { - changeMode(modeType.edit) + if (isAllowUserChangeMode()) { return changeMode(modeType.edit) } }) // view ui.toolbar.view.click(function () { @@ -1579,7 +1651,7 @@ ui.toolbar.view.click(function () { }) // both ui.toolbar.both.click(function () { - changeMode(modeType.both) + if (isAllowUserChangeMode()) { return changeMode(modeType.both) } }) ui.toolbar.night.click(function () { @@ -2047,6 +2119,16 @@ socket.on('refresh', function (data) { editor.setOption('maxLength', editorInstance.config.docmaxlength) updateInfo(data) updatePermission(data.permission) + currentPermission = data.permission + // run allowVisibleSource functionality + if (ui.toolbar.edit.data('blockSource')) { + try { + checkParameter(userIsLogin(personalInfo), currentPermission) + } catch (error) { + console.log(error) + } + } + if (ui.toolbar.edit.data('blockSource') && blockSourceView) { replaceUrlToViewMode(window.location.href) } if (!window.loaded) { // auto change mode if no content detected var nocontent = editor.getValue().length <= 0 diff --git a/public/views/codimd/header.ejs b/public/views/codimd/header.ejs index 86c006f783..3ecbf98334 100644 --- a/public/views/codimd/header.ejs +++ b/public/views/codimd/header.ejs @@ -76,20 +76,35 @@
  • Help
    • - + <% if(!allowVisibleSource) { %> + + <% } else { %> + + + + <% } %>
      - - + <% if(!allowVisibleSource) { %> + + + <% } else { %> + + + <% } %> From 233ef71515c7897f99a0e84fbd1b6af7601d270c Mon Sep 17 00:00:00 2001 From: JamesHow1ett Date: Thu, 26 Nov 2020 15:09:38 +0200 Subject: [PATCH 2/4] disabled all controls where user can get access to source code Signed-off-by: JamesHow1ett --- public/css/index.css | 10 ++++++ public/js/index.js | 53 ++++++++++++++++++++++------- public/js/lib/editor/ui-elements.js | 3 +- 3 files changed, 52 insertions(+), 14 deletions(-) diff --git a/public/css/index.css b/public/css/index.css index eeb1f8b98a..9658fa3b26 100644 --- a/public/css/index.css +++ b/public/css/index.css @@ -11,6 +11,16 @@ body { /*overflow: hidden;*/ } +a[disabled='disabled'] { + color: #939090 !important; + cursor: not-allowed; + pointer-events: none; +} + +a[disabled='disabled']:hover { + color: #939090 !important; +} + .night a, .night .open-files-container li.selected a { color: #5EB7E0; diff --git a/public/js/index.js b/public/js/index.js index 8b86af65cb..ae3f281e58 100644 --- a/public/js/index.js +++ b/public/js/index.js @@ -321,6 +321,21 @@ defaultTextHeight = parseInt($('.CodeMirror').css('line-height')) // initalize ui reference const ui = getUIElements() +//controls to need disabled when allowVisibleSource run +//this prevent user to access source code +const modeChangeControls = { + edit: ui.toolbar.edit, + both: ui.toolbar.both, +} +const exportImportControls = { + revision: ui.toolbar.extra.revision, + markdown: ui.toolbar.download.markdown, + rawhtml: ui.toolbar.download.rawhtml, + gist: ui.toolbar.import.gist, + clipboard: ui.toolbar.import.clipboard, + pandoc: ui.toolbar.download.pandoc +} + // page actions var opts = { lines: 11, // The number of lines to draw @@ -529,10 +544,10 @@ function allowVisibleSource (isLogin, permission) { case 'limited': if (!isLogin) { blockSourceView = true - disableModeChangeControls() + disableControls() } else { blockSourceView = false - enableModeChangeControls() + enableControls() } break case 'locked': @@ -542,24 +557,36 @@ function allowVisibleSource (isLogin, permission) { blockSourceView = false } else { blockSourceView = true - disableModeChangeControls() + disableControls() } break } } -function disableModeChangeControls () { - ui.toolbar.edit.attr({ - disabled: 'true' - }) - ui.toolbar.both.attr({ - disabled: 'true' - }) +function disableControls () { + for (let key of Object.keys(modeChangeControls)) { + modeChangeControls[key].attr({ + disabled: 'disabled' + }) + } + for (let key of Object.keys(exportImportControls)) { + exportImportControls[key].attr({ + disabled: 'disabled', + title: 'disabled by permission' + }) + } } -function enableModeChangeControls () { - ui.toolbar.edit.removeAttr('disabled') - ui.toolbar.both.removeAttr('disabled') +function enableControls () { + for (let key of Object.keys(modeChangeControls)) { + modeChangeControls[key].removeAttr('disable') + } + for (let key of Object.keys(exportImportControls)) { + exportImportControls[key].removeAttr({ + disable, + title + }) + } } function userIsLogin (userPersonalInfo) { diff --git a/public/js/lib/editor/ui-elements.js b/public/js/lib/editor/ui-elements.js index d084607fb1..f7b37fe319 100644 --- a/public/js/lib/editor/ui-elements.js +++ b/public/js/lib/editor/ui-elements.js @@ -19,7 +19,8 @@ export const getUIElements = () => ({ markdown: $('.ui-download-markdown'), html: $('.ui-download-html'), rawhtml: $('.ui-download-raw-html'), - pdf: $('.ui-download-pdf-beta') + pdf: $('.ui-download-pdf-beta'), + pandoc: $('.ui-download-pandoc') }, export: { dropbox: $('.ui-save-dropbox'), From fee6c46341dce56a9202d6215c7adb092b1f77af Mon Sep 17 00:00:00 2001 From: JamesHow1ett Date: Thu, 26 Nov 2020 15:21:38 +0200 Subject: [PATCH 3/4] passing tests Signed-off-by: JamesHow1ett --- public/js/index.js | 22 +++++++++------------- 1 file changed, 9 insertions(+), 13 deletions(-) diff --git a/public/js/index.js b/public/js/index.js index ae3f281e58..063688b751 100644 --- a/public/js/index.js +++ b/public/js/index.js @@ -321,11 +321,11 @@ defaultTextHeight = parseInt($('.CodeMirror').css('line-height')) // initalize ui reference const ui = getUIElements() -//controls to need disabled when allowVisibleSource run -//this prevent user to access source code +// controls to need disabled when allowVisibleSource run +// this prevent user to access source code const modeChangeControls = { edit: ui.toolbar.edit, - both: ui.toolbar.both, + both: ui.toolbar.both } const exportImportControls = { revision: ui.toolbar.extra.revision, @@ -564,28 +564,24 @@ function allowVisibleSource (isLogin, permission) { } function disableControls () { - for (let key of Object.keys(modeChangeControls)) { + for (const key of Object.keys(modeChangeControls)) { modeChangeControls[key].attr({ disabled: 'disabled' }) } - for (let key of Object.keys(exportImportControls)) { + for (const key of Object.keys(exportImportControls)) { exportImportControls[key].attr({ - disabled: 'disabled', - title: 'disabled by permission' + disabled: 'disabled' }) } } function enableControls () { - for (let key of Object.keys(modeChangeControls)) { + for (const key of Object.keys(modeChangeControls)) { modeChangeControls[key].removeAttr('disable') } - for (let key of Object.keys(exportImportControls)) { - exportImportControls[key].removeAttr({ - disable, - title - }) + for (const key of Object.keys(exportImportControls)) { + exportImportControls[key].removeAttr('disable') } } From 1d4130ad1f38f42e863faec0ede4afd962609fdd Mon Sep 17 00:00:00 2001 From: JamesHow1ett Date: Tue, 1 Dec 2020 16:37:33 +0200 Subject: [PATCH 4/4] add css rule for parent disabled element Signed-off-by: JamesHow1ett --- public/css/index.css | 1 - public/js/index.js | 1 + 2 files changed, 1 insertion(+), 1 deletion(-) diff --git a/public/css/index.css b/public/css/index.css index 9658fa3b26..3a2698d5e8 100644 --- a/public/css/index.css +++ b/public/css/index.css @@ -13,7 +13,6 @@ body { a[disabled='disabled'] { color: #939090 !important; - cursor: not-allowed; pointer-events: none; } diff --git a/public/js/index.js b/public/js/index.js index 063688b751..2cf7e392ea 100644 --- a/public/js/index.js +++ b/public/js/index.js @@ -573,6 +573,7 @@ function disableControls () { exportImportControls[key].attr({ disabled: 'disabled' }) + exportImportControls[key].parent().css('cursor', 'not-allowed') } }