Free SERM (Supportsuite Enhanced Right Management)

[Sheep]

SERM (Supportsuite Enhanced Right Management)
SERM is a module for Kayako Supportsuite 3.10.02 and 3.11.0 that allows you to use enhanced permissions on resources (dl, kb, ts) using group of rights.

Project started here:
[WIP] new module: SERM (Supportsuite Enhanced Right Management) - Kayako Community Forums

Updates
31/07/07 - Updated for SupportSuite 3.11.0 (SERM v1.1)
the Bug fix is included in the install guide
30/07/07 - Bug found
20/07/07 – Description redone
19/07/07 – SERM v1 released

Features altered
IRS
Search
Modules: Downloads/Knowledgebase/Troubleshooters
Client index (popular/latest)

Requirement
Kayako Supportsuite (or eSupport) 3.10.02 or 3.11.0 Owned License
This “fix” http://forums.kayako.com/showpost.php?p=56514&postcount=7
If you're runing 3.10.02 use SERM v1.0!

Installation Guide
Download the archive (see attachment)
Extract all files in the module folder (you should get folders like this: modules/serm/*.php - 5 files)
Follow the guide in setup.php (comments at the beginning)
Go to http://mysite.domain/support/setup/
Click on modify
Go to the last step and click on Install (in the SERM line)

First time guide
Go the staff panel
Go to the “rights” tab > Manage rights
Create a subgroup (from the root) called guest
Create a subgroup (from guest) called registered
Go to Manage Usergroups
Click on Guest
Click on the RightGroups tab
Check the Guest mark
Submit
Go to Manage Usergroups
Click on Registered
Click on the RightGroups tab
Check the Registered mark
* for each other usergroup check the registered rightgroup
You have now a basic setting. You can now create new rightgroups and handle permissions.

Conditions terms
There’s no real license behind this but here are the main lines:
- You CANNOT sell this module without my agreement (but I don’t think I’ll give it)
- Kayako Infotech Ltd. is allowed to do what they want with this module.
- You can modify it as you want/need (but please share your modifications on the forum!)
- This module is provided “as it”. No support/guarantee. Use it at your own risks (but I don’t know what risks there could be… maybe security?)

Improvements
What can be done :
- Externalise language phrases (atm they’re hard codded)
- Improve type check on queries (not done atm, this can be a security issue)
- Handle file per file permissions (atm it’s only categories)
- Handle user per user permissions (atm it’s only usergroups)
- Extend SERM to other features (SERM is well modulable because the right table can be used like a data warehouse with changeable values for the targettype (atm only DL/KB/TS)

What / Who / Why?
This module has been done for SPECIFIC needs of EONA (French company) for a project of support platform. This module has been coded by a trainee-student (Antoine BERMON).
Cost for EONA would have been roughly 1400€ (analysis, code, workflow analysis, tests, documentation) but in fact only 350€ because I’m a trainee, but it’s given FREE to the kayako community because EONA doesn’t have time to improve it (and I’m going to leave as my training period is getting over) and I hope someone will continue it.
If you’re motivated you can make a donation

Thanks and Greetings to
Jamie (kayako), Varun (kayako), Julien (EONA), Craig Brass (Community), Mehul “SIORA” (Community), Mark Dahl “gmg” (Community), and to all the forgotten people.

Contact
You can contact me using my MSN/eMail (remove the spaces, add a @ and dots) sheepux - live -com

Bugs
Bug1 (v1.0) - the RSS doesn't work anymore when SERM is installed
Fix: [MODULE] SERM (Supportsuite Enhanced Right Management) - Kayako Community Forums

[craigbrass]

Nice job Antoine. Thanks for sharing. Will give this a whirl tomorrow.

[Sheep]

Description redone, what do you think of it?

[Inaba]

This doesn't appear to work for Downloads and Troubleshooters. Those fields/tabs are blank when I select them. There is also no way to save the check marks under the Knowledgebase tab.

Don't think I screwed anything up...

[Sheep]

did you applied the "fix" ?

[Inaba]

I missed the fix ... I just applied it. Seems to be working now I think.

[Sheep]

that's good to know that it was the issue!
I know i've not done a guide, but tell me what you understand of it without having one. That will help me to create a good guide

[Sheep]

Bug found!

Symptoms
the RSS doesn't work anymore when SERM is installed

Reasons
The RSS doesn't use a user identification, so the swift variable that helps SERM to identify the group of the current user (yes "guest" is also a user) isn't defined, generating an SQL error.

Fix
in modules/downloads/function_clientdl.php
and modules/knowledgebase/function_clientkb.php
look for the function

PHP Code:

function getSubCategories( 


look for the SERM part
(you can find it with)

PHP Code:

    //---SERM---// 


wrap the whole SERM part with

PHP Code:

    if (isset($_SWIFT["user"]["usergroupid"]))
    {
        //REMOVE THIS COMMENT AND LET THE SERM CODE HERE
    }
    else {
        //COPY BACK THE ORIGINAL QUERY (look for it in setup.php)
    } 


That's it.

Limits
There's no longer right checks on RSS, meaning that any user that access to the category RSS can view what's in the category (but can't access the articles as there's a second check).

[Sheep]

version 1.1 is out for compatibility purpose with 3.11.0
(only 3 queries changed)
The bug fix is included in the install guide.

Greetings,
Antoine

[jptimone]

This module looks promising but the zip-files seems to be corrupted? Could someone upload them again?

[craigbrass]

Both open fine for me. What are you using to unzip?

[jptimone]

Originally Posted by craigbrass

Both open fine for me. What are you using to unzip?

Very strange, I use 7-zip and it worked in other computer but not in web server I was working on. But got it in my computer so now testing...

[Sarah_User]

I'm having trouble with the downloads section in serm. I have a download in a category, and then i gave the user rights to the category...and then I get a blank page when I click on the downloads link.....


Any ideas?

Thanks!
Sarah

[Sheep]

Hi sarah, sorry for being late:

in modules/serm/functions_serm.php
find

PHP Code:

function sermCheck( 


uncomment (remove the //) the following line:

PHP Code:

//echo "$usergroupid - $ressourcetype - $ressourceid - $isallowed[count]"; 


Please, let me know what is displays now.

[mopa]

Is it only me or are those files corrupt?
Could someone please send me a v1.1 of the abowe or better yet (replace the file if it is not working)