Difference between revisions of "Scripting - OpenKM 5.1"
| Line 161: | Line 161: | ||
</source> | </source> | ||
| − | === After uploading a file remove all grants except read | + | See related forum topic [http://forum.openkm.com/viewtopic.php?f=6&t=5360 Using Beanshell to move Mails]. |
| + | |||
| + | === After uploading a file, remove all grants - except read - to all users but mantain to uploader === | ||
The Script should remove all grants for all users and roles except read and will continue mantaining privileges to uploader user. | The Script should remove all grants for all users and roles except read and will continue mantaining privileges to uploader user. | ||
| Line 194: | Line 196: | ||
</source> | </source> | ||
| − | |||
[[Category: Administration Guide]] | [[Category: Administration Guide]] | ||
Revision as of 11:40, 22 September 2011
Scripting is an advanced feature - some experimental - that enables administrator to execute some scripts in folders fired each time has been some events there ( for example uploading documents ). It could be useful for making automatic operations in all repository.
 |
OpenKM uses BeanShell. For more information point your browser to http://www.beanshell.org/intro.html. |
BeanShell is a small, free, embeddable Java source interpreter with object scripting language features, written in Java. BeanShell dynamically executes standard Java syntax and extends it with common scripting conveniences such as loose types, commands, and method closures like those in Perl and JavaScript.
Starting with OpenKM 5.0 you can also execute a custom script when OpenKM starts or stop. To do so, just create a start.bsh (and / or stop.bsh) file at $JBOSS_HOME. For example, we use this feature to create a complete environment (create custom users, register property groups, register workflow) each time the OpenKM demo is reinitialized.
Variable substitution
- java.lang.String eventType - says the event that has fired the script. See below for event types.
- javax.jcr.Session session - users session that executes the script.
- javax.jcr.Node eventNode - node that causes the event.
- javax.jcr.Node scriptNode - node where is stored the script.
Events types
- CREATE_DOCUMENT
- DELETE_DOCUMENT
- SET_DOCUMENT_CONTENT
- SET_DOCUMENT_PROPERTIES
- CHECKOUT_DOCUMENT
- CANCEL_CHECKOUT_DOCUMENT
- CHECKIN_DOCUMENT
- LOCK_DOCUMENT
- UNLOCK_DOCUMENT
- PURGE_DOCUMENT
- CREATE_FOLDER
- DELETE_FOLDER
- PURGE_FOLDER
- CREATE_MAIL
- DELETE_MAIL
- PURGE_MAIL
- ADD_CATEGORY
- REMOVE_CATEGORY
- ADD_KEYWORD
- REMOVE_KEYWORD
Examples
 |
To register these example you must go to repository view, select some folder for example into /okm:root/Books/ and set script to enable mixing. It'll appear new property okm:scripCode now must edit it and paste the code from scripting example. |
|
If you are using OpenKM 4.1 (or previous), the right package is "es.git.openkm". The package "com.openkm" is valid starting at OpenKM 5.0 |
Automatic renaming document
String parent = com.openkm.util.FileUtils.getParent(eventNode.getPath());
session.move(eventNode.getPath(), parent+"/renamed_document.doc");
session.save();
Automatic adding keyword
eventNode.setProperty("okm:keywords", new String[]{"maligno"});
eventNode.save();
Change log level
import org.apache.log4j.*;
Logger log = Logger.getLogger("com.openkm.module");
log.setLevel(Level.DEBUG);
Reload log configuration
This sample work-as-is in OpenKM-LTE.
import org.apache.log4j.*;
import com.openkm.util.*;
String filename = ServerDetector.getHomeDir() + "/lib/log4j.properties";
new PropertyConfigurator().doConfigure(filename, LogManager.getLoggerRepository());
Purge all users trash
Works on OpenKM 5.1 branch.
import javax.jcr.*;
import com.openkm.core.*;
import com.openkm.bean.*;
import com.openkm.module.base.*;
String token = JcrSessionManager.getInstance().getSystemToken();
Session session = JcrSessionManager.getInstance().get(token);
Node trash = session.getRootNode().getNode(Repository.TRASH);
for (NodeIterator it = trash.getNodes(); it.hasNext(); ) {
Node userTrash = it.nextNode();
print("User Trash: " + userTrash.getPath() + "<br/>");
for (NodeIterator itut = userTrash.getNodes(); itut.hasNext(); ) {
Node child = itut.nextNode();
print("About to delete: " + child.getPath() + "<br/>");
if (child.isNodeType(Document.TYPE)) {
BaseDocumentModule.purge(session, child.getParent(), child);
} else if (child.isNodeType(Folder.TYPE)) {
BaseFolderModule.purge(session, child);
}
}
userTrash.save();
}
You can see also a modified version with runs on older OpenKM 5.0 branch at Forum: Purge trash of all users.
Using Beanshell to move Mails
The Script should check a specific Mail folder ("Docs") and move all the mails in another folder ("okm:root/Mails") in the Taxonomy. This runs as a Cronjob.
import javax.jcr.*;
import com.openkm.core.*;
import com.openkm.bean.*;
import com.openkm.module.*;
String token = JcrSessionManager.getInstance().getSystemToken();
Session session = JcrSessionManager.getInstance().get(token);
Node okmmail = session.getRootNode().getNode(Repository.MAIL);
Node okmroot = session.getRootNode().getNode(Repository.ROOT);
for (NodeIterator it = okmmail.getNodes(); it.hasNext(); ) {
Node userMailFolder = it.nextNode();
if( userMailFolder.getPath().equals("/okm:mail/Docs") ) {
//Check the mail in the "Docs" folder
for (NodeIterator itut = userMailFolder.getNodes(); itut.hasNext(); ) {
Node mail = itut.nextNode();
String name = mail.getName();
//Check the keyword
int available = name.indexOf("al");
if (available != -1){
session.move(mail.getPath(), okmroot.getPath() + "/alFolder/" + mail.getName());
session.save();
}
available = name.indexOf("ka");
if (available != -1){
session.move(mail.getPath(), okmroot.getPath() + "/kaFolder/" + mail.getName());
session.save();
}
}
userMailFolder.save();
}
}
See related forum topic Using Beanshell to move Mails.
After uploading a file, remove all grants - except read - to all users but mantain to uploader
The Script should remove all grants for all users and roles except read and will continue mantaining privileges to uploader user.
import java.util.Map;
import com.openkm.api.OKMAuth;
import com.openkm.bean.Permission;
if (eventType.equals("CREATE_DOCUMENT")) {
String userId = session.getUserID();
String path = eventNode.getPath();
OKMAuth oKMAuth = OKMAuth.getInstance();
// All Roles only will continue having read grants
Map hm = oKMAuth.getGrantedRoles(null, path);
for (String roleName : hm.keySet()) {
oKMAuth.revokeRole(null, path, roleName, Permission.WRITE, false);
oKMAuth.revokeRole(null, path, roleName, Permission.DELETE, false);
oKMAuth.revokeRole(null, path, roleName, Permission.SECURITY, false);
}
// All users only will continue having read grants
hm = oKMAuth.getGrantedUsers(null, path);
for (String userName : hm.keySet()) {
if (!session.getUserID().equals(userName)) {
oKMAuth.revokeUser(null, path, userName, Permission.WRITE, false);
oKMAuth.revokeUser(null, path, userName, Permission.DELETE, false);
oKMAuth.revokeUser(null, path, userName, Permission.SECURITY, false);
}
}
}
