Protected check on object

[buzzia2001]

Changes

This PR adds a check on “protected” filters for objects as well

How to test this PR

Create a “protected” filter; when you click on an object, there should be no options to rename, move, or delete objects.
The actions to be performed must also be flagged to run in a protected environment.

Checklist

• have tested my change
• have created one or more test cases
• updated relevant documentation
• Remove any/all console.logs I added
• have added myself to the contributors' list in CONTRIBUTING.md

[github-actions]

👋 A new build is available for this PR based on 081bd22.

• Download here.
• Read more about how to test

[sebjulliand]

@buzzia2001 overall it's OK, but there are a couple of things to change.

And I guess think you can push the logic a bit further:

• the code-for-ibmi.createSourceFile command should also not be allowed to run on protected targets (filters and library objects)
• the isProtected() abstract method from ObjectBrowserItem should be pulled up into its super class ObjectItem. Then, DebugItem and EnvironmentItem will define it to always return false, and IFSItem can benefit from it and return an actual value, based on the actual protection status of the IFS item. Thi seems to be a cleaner approach and avoid type checks like { isProtected()?: boolean }.

[sebjulliand]

The whole function should be like this to take into account library objects:

const extension = uri.path.substring(uri.path.lastIndexOf(`.`) + 1).toUpperCase();
  let path = uri.path;
  if (uri.scheme === `object`) {
    const qsysPath = Tools.parseQSysPath(path);
    path = (extension === 'LIB' ? qsysPath.name.split('.')[0] : qsysPath.library);
  }
  return {
    uri,
    extension,
    fragment: uri.fragment.toUpperCase(),
    protected: ibmi?.getConfig().readOnlyMode ||
      parseFSOptions(uri).readonly || 
      ibmi?.getContent().isProtectedPath(path) ||
      false,
    workspaceFolder: workspaceFolder || vscode.workspace.getWorkspaceFolder(uri),
    executionOK: false,
    hasRun: false,
    processed: false,
    output: []
  };

[sebjulliand]

This is enough; all nodes from the object browser extend ObjectBrowserItem that defines isProtected().

Suggested change

	if (node instanceof ObjectBrowserItem && checkProtected(node)) {
	if (node && checkProtected(node)) {

[sebjulliand]

node is always defined and its type will always inherit ObjectBrowserItem that always defines isProtected().

Suggested change

	function checkProtected(node: { isProtected?: () => boolean, toString(): string }): boolean {
	if (node?.isProtected?.()) {
	vscode.window.showWarningMessage(vscode.l10n.t(`{0} is in a protected filter or library and cannot be modified.`, node.toString()));
	return true;
	}
	return false;
	}
	function checkProtected(node: ObjectBrowserItem): boolean {
	if (node.isProtected()) {
	vscode.window.showWarningMessage(vscode.l10n.t(`{0} is in a protected filter or library and cannot be modified.`, node.toString()));
	return true;
	}
	return false;
	}

[buzzia2001]

@sebjulliand to you

[sebjulliand]

We're almost there @buzzia2001!

Now that we have the protected state accross the IFS browser, actions that cannot run on protected IFS files should be hidden.

These four specifically:

Keep up the good work! 😄

[sebjulliand]

Since the path protection applies to directories, a file needs to check its parent node protection state.

Suggested change

	return isProtected(this.path);
	return this.file.type === "directory" ? isProtected(this.path) : this.parent?.isProtected() || false;

[github-actions]

👋 A new build is available for this PR based on 679fd31.

• Download here.
• Read more about how to test

[buzzia2001]

@sebjulliand I hope we've reached the end of this PR hahaha

[sebjulliand]

@buzzia2001 it's all good!

Just one thing I noticed, not directly related to this PR but worth fixing while we're at it: the IFS paths isProtected check is case sensitive, which is only valid for /QOpensys paths. The rest of the IFS FS is case insensitive.

So here is an enhancement for the isProtectedPath() function in IBMIContent.ts on line 1058:

  isProtectedPath(path: string) {
    if (path[0] === '/') { //IFS path
      //QOpensys FS is case sensistive
      const flag = /^\/QOpenSys/i.test(path) ? '' : 'i';
      return this.config.protectedPaths.some(p => new RegExp(escapeStringRegexp(p), flag).test(path));
    }
    else { //QSYS path
      const qsysObject = Tools.parseQSysPath(path);
      return this.config.protectedPaths.includes(this.ibmi.upperCaseName(qsysObject.library));
    }
  }

With this, we make the check case insensitive unless the protected path is in QOpenSys.

[buzzia2001]

@sebjulliand to you

[sebjulliand]

Good job @buzzia2001 , it's fully working!