Archive

Archive for August, 2011

Removing Permission of a User or Group in Alfresco Using Javascript

August 12, 2011 1 comment

REMOVING PERMISSIONS IN ALFRESCO…

In my last post, I have discussed how you can grant permissions to a user or group in a certain space or folder. This can be done by either using the Alfresco Web Client (Alfresco UI) or by using the permission service JavaScript API provided by Alfresco. By creating a JavaScript web script, one can add or delete permissions of a user or group in a specific folder/space. This post is  related to my previous post I created,  but in this section we will  discuss about removing the permission applied using JavaScript API.

THE JAVASCRIPT API…

Alfresco provided a javascript API we can use to remove set permissions. Below are the two methods we can use:

1. void removePermission(string permission) – Remove a permission for ALL users from the node.

2. void removePermission(string permission, string authority) – Remove a permission for the specified authority (e.g. username or group) from the node.

As an example (taken from my previous post), we can also create  another web scripts which removes permission on a node:

a. removePermission.get.desc.xml – the descriptor file that will register our web script, example:

<webscript>
    <shortname>Remove Permission</shortname>
    <description>Remove Permission of a User or  Group from a Folder or Space</description>
    <url>/remove/folder/permission/?folderName={folderName}</url>
    <format default=”html”/>
    <authentication>admin</authentication>
</webscript>

b.  removePermission.get.html.ftl –  the file that will display the response from Alfresco, example:

<html>
<body>
<p>${myStatus}</p>
</body>
</html>

c. removePermission.get.js – java-script that will contain the logic of our code. Here, we will use Alfresco java-script API for  setting the permission of  a folder, example:

/*Remove permission to a folder using Alfresco javascript API*/

//search for the folder node using lucene search
var folderNode =  search.luceneSearch(“TYPE:\”{http://www.alfresco.org/model/content/1.0}folder\” AND @cm\\:name:”+args.folderName);

//make sure we only get one node

if(folderNode.length == 1){
//remove permission “Contributor” from all users or group
folderNode[0].removePermission(“Contributor”);
//remove permission “Contributor” from group ANYTHINGALFRESCOGROUP

folderNode[0].removePermission(“Contributor”, “GROUP_ANYTHINGALFRESCOGROUP”);
model.myStatus = “Permission was removed successfully!”;
}else  if (folderNode.length == 0){
//no node was found
model.myStatus = “Folder not found”;
}else{
//either greater than two  was found
model.myStatus = “Duplicate folder found”;
}

You can try the above code on your Alfresco installation and see if it works. Just follow the steps on how  to create a web script and upload it in Web Scripts Extension space. I hope this helps! =P

Adding Permissions using Alfresco Javascript API

August 4, 2011 5 comments

ADDING PERMISSIONS…

On my last post, I have discussed how permissions can be applied in a folder using the Alfresco web client. This is very helpful for first time users of Alfresco. Permission plays an important part in Alfresco Administration as this can be used to control access of users to folders or documents. However, for advanced users some might require adding them automatically or even might have a requirement where you add permissions without going through to many clicks in the Alfresco web client. Applying permissions is also possible using JAVA APIs exposed by Alfresco. But, there is also another way for non-Java guys by using Alfresco JavaScript API.

In this post, I will show you how you can add a permission using JavaScript API. I will be using a simple web script to add permissions to a given folder name.

CREATING THE PERMISSION  WEB SCRIPT

1. Log in as  admin in Alfresco and go to Company Home/Data Dictionary/Web Scripts Extensions

Figure 1: Web Scripts Extensions Page

2. Create a folder/space that  will contain our web script files e.g. setPermission folder

3. In the created folder, create 3 files that will complete our web script.

a. setPermission.get.desc.xml – the descriptor file that will register our web script, example:

<webscript>
    <shortname>Set Permission</shortname>
    <description>Set Permission using javascript API</description>
    <url>/set/folder/permission/?folderName={folderName}</url>
    <format default=”html”/>
    <authentication>admin</authentication>
</webscript>

b.  setPermission.get.html.ftl –  the file that will display the response from Alfresco, example:

<html>
<body>
<p>${myStatus}</p>
</body>
</html>

c. setPermission.get.js – java-script that will contain the logic of our code. Here, we will use Alfresco java-script API for  setting the permission of  a folder, example:

/*Set permission to a folder using Alfresco javascript API*/

//search for the folder node using lucene search
var folderNode =  search.luceneSearch(“TYPE:\”{http://www.alfresco.org/model/content/1.0}folder\” AND @cm\\:name:”+args.folderName);

//make sure we only get one node

if(folderNode.length == 1){
//set permission “Contributor” to user with username “anythingalfresco” and group “ANYTHINGALFRESCOGROUP”
folderNode[0].setPermission(“Contributor”, “anythingalfresco”);
folderNode[0].setPermission(“Contributor”, “GROUP_ANYTHINGALFRESCOGROUP”);
model.myStatus = “Permission was set successfully!”;
}else  if (folderNode.length == 0){
//no node was found
model.myStatus = “Folder not found”;
}else{
//either greater than two  was found
model.myStatus = “Duplicate folder found”;
}

Below is the API for  applying permissions:

void setPermission(string permission, string authority) 
Parameters:
string permission – a string representation of  the permission or role you want to assign to a user or a group. Note that this permission should exist in Alfresco otherwise you will get an error like the one below:

Figure 2: Permission Error

string authority – string representation of the username or a group name you want to have permissions. For groups, append “GROUP_” before the group name. Alfresco will not produce error if a username or group does  not exist (at least in my test!).

4. Go to web scripts home (http://localhost:8080/alfresco/service/index) and click Refresh Web Scripts button
5. On a new tab, invoke your web script:
          http://localhost:8080/alfresco/set/folder/permission/?folderName=Folder A
If all goes well, you should be able to  see a response “Permission was set successfully!”

Figure 3: Permission Applied

Now we are done! Note that this is just a simple code. You are free to experiment with the code at your own risk 🙂
I  hope this helps!