Add new config option allowVisibleSource #1599

roman-yatsenko · 2020-09-18T12:11:48Z

Add new config option allowVisibleSource to the project. The default value for this option is true. The false value will block Edit and Both editor modes for users that have no rights to edit a note.

Pull request adds:

new config option allowVisibleSource with default value true;
new environment variable CMD_VISIBLE_SOURCE;
disable Edit and Both modes for users without edit note permission;
redirect form Edit and Both modes to View mode by direct URL with mode parameter.

…ными

…ными Signed-off-by: JamesHow1ett <[email protected]>

Signed-off-by: JamesHow1ett <[email protected]>

…create disable\enabel fn's Signed-off-by: JamesHow1ett <[email protected]>

Signed-off-by: JamesHow1ett <[email protected]>

a60814billy · 2020-10-22T23:58:33Z

lib/config/default.js

@@ -33,6 +33,7 @@ module.exports = {
  allowAnonymousEdits: true,
  allowAnonymousViews: true,
  allowFreeURL: false,
+  allowVisibleSource: true,


To prevent broken current behavior, set the default value to false

With the default value true user can see note source (edit and both modes are enabled for view to user without edit rights). The true value is an usual CodiMD behavior for now.
P.S. But we've refactored as you wish :-)

a60814billy · 2020-10-22T23:59:30Z

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_VISIBLE_SOURCE),


following coding convention,
change the environment variable name to CMD_ALLOW_VISIBLE_SOURCE

a60814billy · 2020-10-23T01:57:36Z

public/js/index.js

@@ -499,6 +505,71 @@ $(window).on('error', function () {
  // setNeedRefresh();
 })

+function checkParametr (isLogin, permission) {
+  if (typeof isLogin !== 'boolean' || !permission) {
+    throw new Error('one or more parametr is incorrect')


Suggested change

throw new Error('one or more parametr is incorrect')

throw new Error('one or more parameter is incorrect')

a60814billy · 2020-10-23T01:57:56Z

public/js/index.js

+function checkParametr (isLogin, permission) {
+  if (typeof isLogin !== 'boolean' || !permission) {
+    throw new Error('one or more parametr is incorrect')
+  } else return allowVisibleSource(isLogin, permission)


Suggested change

} else return allowVisibleSource(isLogin, permission)

}

return allowVisibleSource(isLogin, permission)

a60814billy · 2020-10-23T02:03:49Z

public/js/index.js

+  }
+}
+
+function disableControls () {


Using more precise function name here.
Maybe can change disableControlsto disableModeChangeControls and
enableControls to enableModeChangeControls

a60814billy · 2020-10-23T02:07:44Z

public/js/index.js

@@ -499,6 +505,71 @@ $(window).on('error', function () {
  // setNeedRefresh();
 })

+function checkParametr (isLogin, permission) {


Suggested change

function checkParametr (isLogin, permission) {

function checkParameter (isLogin, permission) {

a60814billy · 2020-10-23T02:08:32Z

public/js/index.js

+  } else return allowVisibleSource(isLogin, permission)
+}
+
+function replaceUrl (url) {


replaceUrl -> replaceUrlToViewMode

a60814billy · 2020-10-23T02:15:01Z

public/js/index.js

+}
+
+function userIsLogin (userPersonalInfo) {
+  if (Object.prototype.hasOwnProperty.call(userPersonalInfo, 'login')) {


function userIsLogin (userPersonalInfo) { return !!userPersonalInfo && !!userPersonalInfo.login }

a60814billy · 2020-10-23T02:21:37Z

public/js/index.js

@@ -1567,10 +1638,14 @@ function importFromUrl (url) {

 // mode
 ui.toolbar.mode.click(function () {


introduce a function isAllowUserChangeMode

function isAllowUserChangeMode () { const isOwner = personalInfo.userid && window.owner && personalInfo.userid === window.owner return isOwner || !blockSourceView }

and mode select logic would be

if (isAllowUserChangeMode()) { return toggleMode() }

a60814billy

Hi @roman-yatsenko, thanks for your contribution, It's a good feature.
But we need some refactoring to meet project coding conventions before merge.

a60814billy · 2020-10-23T02:30:18Z

By the way, please sign DCO

Signed-off-by: JamesHow1ett <[email protected]>

roman-yatsenko · 2020-10-26T13:50:19Z

By the way, please sign DCO

We have a git problems with DCO commit signs (Can't sign done commits). Can we accept the pull request without DCO? Or we can create a new pull request with one signed commit with all code.
What we need to do?

a60814billy · 2020-10-30T07:53:16Z

Hi, @roman-yatsenko
Due to AGPL licesne, we can't accept any code without DCO sign. Please open a new pull request to do it!

roman-yatsenko · 2020-11-17T09:53:00Z

Recreated at #1621

JamesHow1ett added 9 commits August 28, 2020 11:08

добавил allowSourceView в конфиг по умолчанию; сделал кнопки не актив…

1bedea0

…ными

добавил переменную CMD_VISIBLE_SOURCE в среду

2f3c5e6

did add locales support for mode btn titles

c5bbeca

block use hotkeys to see source code without rights

11d555f

block use hotkeys to see source code without rights

0463fd2

block use hotkeys to see source code without rights

9b6c167

block use hotkeys to see source code without rights

f063bfc

implement feature to disable veiw source code without rights

6fa747e

minor fix

fdd4e08

roman-yatsenko changed the title ~~Add new config option allowVisibleSource~~ WIP: Add new config option allowVisibleSource Sep 18, 2020

JamesHow1ett and others added 20 commits September 18, 2020 15:34

добавил allowSourceView в конфиг по умолчанию; сделал кнопки не актив…

e2b5239

…ными Signed-off-by: JamesHow1ett <[email protected]>

добавил переменную CMD_VISIBLE_SOURCE в среду

1c63768

Signed-off-by: JamesHow1ett <[email protected]>

did add locales support for mode btn titles

7eec6ca

Signed-off-by: JamesHow1ett <[email protected]>

block use hotkeys to see source code without rights

01daf2c

Signed-off-by: JamesHow1ett <[email protected]>

block use hotkeys to see source code without rights

7ece907

Signed-off-by: JamesHow1ett <[email protected]>

block use hotkeys to see source code without rights

0d531c9

Signed-off-by: JamesHow1ett <[email protected]>

block use hotkeys to see source code without rights

1d2410f

Signed-off-by: JamesHow1ett <[email protected]>

implement feature to disable veiw source code without rights

919a5a4

Signed-off-by: JamesHow1ett <[email protected]>

minor fix

6bb4d3a

Signed-off-by: JamesHow1ett <[email protected]>

disabled change mode view for logout users

7b35425

Signed-off-by: JamesHow1ett <[email protected]>

realese feature

dc40648

Signed-off-by: JamesHow1ett <[email protected]>

remove timeout for call fn; update condition for call replaceUrl fn; …

4471804

…create disable\enabel fn's Signed-off-by: JamesHow1ett <[email protected]>

clean code

296b29a

Signed-off-by: JamesHow1ett <[email protected]>

add function to check paramets for allowVisibleSource fn

2fe4d76

Signed-off-by: JamesHow1ett <[email protected]>

grouped switch cases

2f0b724

Signed-off-by: JamesHow1ett <[email protected]>

clean code

bcabc1f

Signed-off-by: JamesHow1ett <[email protected]>

clean code

4e414db

Signed-off-by: JamesHow1ett <[email protected]>

clean code

b309457

Signed-off-by: JamesHow1ett <[email protected]>

clean code

88fb734

Signed-off-by: JamesHow1ett <[email protected]>

Reset locales

b7bc124

Signed-off-by: JamesHow1ett <[email protected]>

JamesHow1ett force-pushed the feat/allowVisibleSource branch from b918582 to b7bc124 Compare September 18, 2020 12:35

clean code for tests

0af9e41

Signed-off-by: JamesHow1ett <[email protected]>

roman-yatsenko changed the title ~~WIP: Add new config option allowVisibleSource~~ Add new config option allowVisibleSource Sep 18, 2020

roman-yatsenko and others added 2 commits September 24, 2020 13:12

Merge branch 'develop' into feat/allowVisibleSource

9380673

fix code for test comlete

f6aaf9c

Signed-off-by: JamesHow1ett <[email protected]>

Yukaii temporarily deployed to codimd-feat-allowvisibl-khdvhq September 29, 2020 06:08 Inactive

a60814billy reviewed Oct 23, 2020

View reviewed changes

a60814billy requested changes Oct 23, 2020

View reviewed changes

refactoring: changing function names for more information

4d94f77

Signed-off-by: JamesHow1ett <[email protected]>

Yukaii temporarily deployed to codimd-feat-allowvisibl-khdvhq October 26, 2020 12:52 Inactive

JamesHow1ett approved these changes Nov 16, 2020

View reviewed changes

roman-yatsenko closed this Nov 17, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add new config option allowVisibleSource #1599

Add new config option allowVisibleSource #1599

roman-yatsenko commented Sep 18, 2020

a60814billy Oct 22, 2020

roman-yatsenko Oct 26, 2020

a60814billy Oct 22, 2020

a60814billy Oct 23, 2020

a60814billy Oct 23, 2020

a60814billy Oct 23, 2020

a60814billy Oct 23, 2020

a60814billy Oct 23, 2020

a60814billy Oct 23, 2020

a60814billy Oct 23, 2020

a60814billy left a comment

a60814billy commented Oct 23, 2020

roman-yatsenko commented Oct 26, 2020

a60814billy commented Oct 30, 2020

roman-yatsenko commented Nov 17, 2020

	throw new Error('one or more parametr is incorrect')
	throw new Error('one or more parameter is incorrect')

	} else return allowVisibleSource(isLogin, permission)
	}
	return allowVisibleSource(isLogin, permission)

	function checkParametr (isLogin, permission) {
	function checkParameter (isLogin, permission) {

		@@ -1567,10 +1638,14 @@ function importFromUrl (url) {

		// mode
		ui.toolbar.mode.click(function () {

Add new config option allowVisibleSource #1599

Add new config option allowVisibleSource #1599

Conversation

roman-yatsenko commented Sep 18, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

a60814billy left a comment

Choose a reason for hiding this comment

a60814billy commented Oct 23, 2020

roman-yatsenko commented Oct 26, 2020

a60814billy commented Oct 30, 2020

roman-yatsenko commented Nov 17, 2020