Changeset 5370

Timestamp:

Jun 23, 2010, 2:51:50 PM (13 years ago)

Author:

Nicklas Nordborg

Message:

References #1459: Named permissions keys that store predefined permissions for projects/groups/users

Added gui pages for managing permission templates. It is now possible to assign a template to a project and to select templates when sharing items. Eg. item 2 and 3 in the list above have been fully implemented. I think I'll close this ticket now and implement the first item in #1187 or #1236.

Location:

trunk

Files:

• doc/src/docbook/figures/set_permissions.png (modified) (previous)
• doc/src/docbook/userdoc/project_permission.xml (modified) (4 diffs)
• doc/src/docbook/userdoc/webclient.xml (modified) (4 diffs)
• src/core/net/sf/basedb/core/MultiPermissions.java (modified) (1 diff)
• www/common/share/share.jsp (modified) (11 diffs)
• www/common/share/submit_share.jsp (modified) (2 diffs)
• www/include/menu.jsp (modified) (2 diffs)
• www/include/scripts/main.js (modified) (1 diff)
• www/my_base/projects/edit_project.jsp (modified) (9 diffs)
• www/my_base/projects/index.jsp (modified) (3 diffs)
• www/my_base/projects/list_projects.jsp (modified) (2 diffs)
• www/my_base/projects/view_project.jsp (modified) (1 diff)
• www/views/permissiontemplates (added)
• www/views/permissiontemplates/edit_template.jsp (added)
• www/views/permissiontemplates/index.jsp (added)
• www/views/permissiontemplates/list_templates.jsp (added)
• www/views/permissiontemplates/view_template.jsp (added)

trunk/doc/src/docbook/userdoc/project_permission.xml

@@ -315 +315 @@
         <listitem>
           <para>
-          When you create new items, they are automatically added to the active
-          project so
-          there is almost no need to share items manually. All
+          When you create new items, they are automatically shared
+          using the settings from the active project. There is almost no 
+          need to share items manually. All
           you have to remember is to set an active project, and
           this is easy accessible from the 
@@ -355 +355 @@
           You should always, with few exceptions, have a project active 
           when you work with BASE. The most important reason is that 
-          new items will automatically be included in the active project.
-          This considerably reduces the time needed for managing access 
-          permissions. Without an active project you would have to manually
+          new items will automatically be shared using the settings in
+          the active project. This considerably reduces 
+          the time needed for managing access permissions. Without an 
+          active project you would have to manually
           set the permission on all items you create. If you have hundreds
           of items this is a time-consuming and boring task best to be 
@@ -464 +465 @@
           <para>
             When a project is active all new items you create are automatically
-            shared to this project. By default the permission are set to
+            shared using the settings from the active project. If the active project 
+            has a permission template the permissions from the template are copied 
+            to the new item. If the project doesn't have a permission template, the 
+            new item is shared to the active project with the configured default
+            level. By default, projects doesn't have a permission template
+            and the default permissions are set to
             <emphasis>read</emphasis>, <emphasis>use</emphasis>, 
             <emphasis>write</emphasis> and <emphasis>delete</emphasis>. It is
@@ -756 +762 @@
     
     </sect1>
-        
+    
+    <sect1 id="project_permission.templates">
+      <title>Permission templates</title>
+    
+      <para>
+        A <emphasis>permission template</emphasis> is a pre-defined set of permissions
+        for users, groups and/or projects. The template makes it easy to quickly share
+        items to multiple users, groups and projects, possible with different permissions
+        for everyone. There are three major use-cases were permission templates are useful:
+      </para>
+      
+      <itemizedlist>
+        <listitem>
+          <para>
+          A permission template can be associated with project. When the project is selected
+          as the active project, the permissions from the template are copied to any new items
+          that are created. Note that the new items may or may not be shared with the active
+          project, depending on the settings in the permission template. 
+          </para>
+        </listitem>
+        <listitem>
+          <para>
+          Permission templates can be selected in the <link linkend="webclient.items.share">share dialog</link>, 
+          making it easier to manually share items to multiple users, 
+          groups and projects in just a few clicks.
+          </para>
+        </listitem>
+        <listitem>
+          <para>
+          Permission templates can be used with some batch item importers, making it easier
+          for administrators which only needs a single data file even if the data belong to
+          different projects.
+          </para>
+        </listitem>
+      </itemizedlist>
+      
+      <para>
+        Permission templates are managed from the <menuchoice><guimenu>View</guimenu>
+        <guisubmenu>Permission templates</guisubmenu></menuchoice> menu. The template is
+        a very simple item that only has a name (required) and a description (optional).
+        We recommend that the names of the templates are kept unique, but this is not
+        enforced by BASE. To assign permissions to the template use the 
+        <guibutton>Set permissions</guibutton> button. This is the same dialog as the 
+        <link linkend="webclient.items.share">share dialog</link>.
+      </para>
+      
+      <note>
+        <title>Permissions are copied</title>
+        <para>
+        When a permission template is used the permissions are <emphasis>copied</emphasis>
+        to the items. Modifications to the template that are made afterwards doesn't
+        affect the permissions for the items on which the template was used.
+        </para>
+      </note>
+    </sect1>
 </chapter>

trunk/doc/src/docbook/userdoc/webclient.xml

@@ -1216 +1216 @@
           to other users. This is because whenever you work with an active 
           project each new item you create will automatically be shared
-          to that project. In most cases, this is all you need.
+          according to the settings of that project. In most cases, this
+          is all you need.
         </para>
         
@@ -1271 +1272 @@
                 </para>
                 
+                <para>
+                  The <guilabel>Permission templates</guilabel> part of the list
+                  is always empty to begin with.
+                </para>
+                
               </listitem>
             </varlistentry>
@@ -1286 +1292 @@
                 You can select more than one user, group or project
                 and change the permissions for all of them at once.
+                </para>
+                <para>
+                The permission boxes are disabled if a permission template
+                is selected. The permissions are already part of the template
+                and can't be changed here.
                 </para>
               </listitem>
@@ -1348 +1359 @@
                 projects that already have access to the items.
                 </para>
+              </listitem>
+            </varlistentry>
+            
+            <varlistentry>
+              <term><guibutton>Templates</guibutton></term>
+              <listitem>
+                <para>
+                Opens a pop-up window that allows you to select 
+                permission templates. In the pop-up window, mark
+                one or more templates and click on the &gbOk;
+                button. Unless you are an administrator, the pop-up window 
+                will only list templates that you are allowed to use. It will 
+                not list templates that have already been added.
+                </para>
+                
+                <note>
+                  <para>
+                  The permissions from the selected templates are <emphasis>copied</emphasis>
+                  to the items when the access permissions are saved. If you re-open the share dialog,
+                  the actual permissions are shown and the permission templates 
+                  section is empty. Modifying the permission template later doesn't 
+                  affect the permissions on existing items. See <xref linkend="project_permission.templates" /> 
+                  for more information about permission templates.
+                  </para>
+                </note>
+                
               </listitem>
             </varlistentry>

trunk/src/core/net/sf/basedb/core/MultiPermissions.java

@@ -328 +328 @@
   
   /**
+    Merge the permissions from the given item key keeping those
+    that has already been set.
+
+    @param itemKey An item key (if null, this method simply returns)
+    @since 2.16
+    @see UserPermissions#merge(ItemKey)
+    @see GroupPermissions#merge(ItemKey)
+  */
+  public void merge(ItemKey itemKey)
+  {
+    if (itemKey == null) return;
+    for (UserPermissions up : userPermissions.values())
+    {
+      up.merge(itemKey);
+    }
+    for (GroupPermissions gp : groupPermissions.values())
+    {
+      gp.merge(itemKey);
+    }
+  }
+  
+  /**
+    Merge the permissions from the given project key keeping those
+    that has already been set.
+  
+    @param projectKey An project key (if null, this method simply returns)
+    @since 2.16
+    @see ProjectPermissions#merge(ProjectKey)
+  */
+  public void merge(ProjectKey projectKey)
+  {
+    if (projectKey == null) return;
+    for (ProjectPermissions pp : projectPermissions.values())
+    {
+      pp.merge(projectKey);
+    }
+  }
+  
+  /**
     Get a query that returns all users appearing in at least one of
     the item keys. The query will not return users that the logged in 

trunk/www/common/share/share.jsp

@@ -206 +206 @@
       }
       %>
+      Link.addNewSection(members, new Section('T', 'Permission templates'));
     }
     // Submit the form
@@ -214 +215 @@
       frm.modifiedGroups.value = Link.exportModified(frm, 'G').join(',');
       frm.modifiedProjects.value = Link.exportModified(frm, 'P').join(',');
+      frm.permissionTemplates.value = Link.getListIds(frm.members, 'T').join(',');
       frm.submit();
     }
@@ -261 +263 @@
       return s;
     }
-    function showPermissions(permissionCode, disabled)
-    {
+    function showPermissions(permissionCode, isEveryone, isTemplate)
+    {
+      var disabled = isTemplate || (isEveryone && !share_to_everyone);
       var frm = document.forms['share'];
       frm['read'].checked = permissionCode & <%=READ_CODE%>;
@@ -276 +279 @@
       frm['set_owner'].disabled = disabled;
       frm['set_permission'].disabled = disabled;
-      if (disabled)
+      if (isEveryone && !share_to_everyone)
       {
         Main.show('share_disabled');
@@ -299 +302 @@
         {
           var item = option.item;
-          var disabled = item.id == everyone_id && item.type == 'G' && !share_to_everyone;
+          var disabled = item.type == 'T' || (item.id == everyone_id && item.type == 'G' && !share_to_everyone);
           if (!disabled)
           {
@@ -316 +319 @@
       if (item && item.id)
       {
-        var disabled = item.id == everyone_id && item.type == 'G' && !share_to_everyone;
-        showPermissions(item.value, disabled);
+        var isTemplate = item.type == 'T';
+        var isEveryone = item.id == everyone_id && item.type == 'G';
+        showPermissions(item.value, isEveryone, isTemplate);
       }
     }
@@ -334 +338 @@
       if (!item) item = new Item('U', userId, name+' ['+permissionString+']', permissionCode, 0);
       Link.addItem(document.forms['share'].members, item);
+      membersOnChange();
     }
     function addGroupsOnClick()
@@ -356 +361 @@
       if (!item) item = new Item('G', groupId, name+' ['+permissionString+']', permissionCode, 0);
       Link.addItem(document.forms['share'].members, item);
+      membersOnChange();
     }
     function addProjectsOnClick()
@@ -370 +376 @@
       if (!item) item = new Item('P', projectId, name+' ['+permissionString+']', permissionCode, 0);
       Link.addItem(document.forms['share'].members, item);
+      membersOnChange();
+    }
+    function addPermissionTemplateOnClick()
+    {
+      var ids = Link.getListIds(document.forms['share'].members, 'T');
+      var excludes = ids.join(',');
+      Main.openPopup('../../views/permissiontemplates/index.jsp?ID=<%=ID%>&cmd=UpdateContext&mode=selectmultiple&callback=addPermissionTemplateCallback&permission=READ&exclude='+excludes, 'AddPermissionTemplates', 1000, 700);
+    }
+    function addPermissionTemplateCallback(templateId, name)
+    {
+      var item = Link.getItem('T', templateId);
+      if (!item) item = new Item('T', templateId, name, 0, 0);
+      Link.addItem(document.forms['share'].members, item);
+      membersOnChange();
     }
     function removeOnClick()
     {
       Link.removeSelected(document.forms['share'].members);
+      membersOnChange();
     }
     </script>
@@ -395 +416 @@
         <input type="hidden" name="modifiedGroups" value="">
         <input type="hidden" name="modifiedProjects" value="">
+        <input type="hidden" name="permissionTemplates" value="">
       </td>
   
@@ -429 +451 @@
           /></td></tr>
         <tr><td><base:button 
+          onclick="addPermissionTemplateOnClick()" 
+          title="Templates&hellip;" 
+          tooltip="Add permission templates"
+          image="add.png"
+          disabled="<%=!writePermission %>" 
+          /></td></tr>
+        <tr><td><base:button 
           onclick="removeOnClick()" 
           title="Remove" 

trunk/www/common/share/submit_share.jsp

@@ -47 +47 @@
   import="net.sf.basedb.core.Group"
   import="net.sf.basedb.core.Project"
+  import="net.sf.basedb.core.PermissionTemplate"
   import="net.sf.basedb.clients.web.Base"
   import="net.sf.basedb.clients.web.PermissionUtil"
@@ -106 +107 @@
       }
     }
+    
+    String[] permissionTemplates = Values.getString(request.getParameter("permissionTemplates")).split(",");
+    for (int i = 0; i < permissionTemplates.length; ++i)
+    {
+      int permissionTemplateId = Values.getInt(permissionTemplates[i], -1);
+      if (permissionTemplateId != -1) 
+      {
+        PermissionTemplate template = PermissionTemplate.getById(dc, permissionTemplateId);
+        mp.merge(template.getItemKey());
+        mp.merge(template.getProjectKey());
+      }
+    }
+  
+    
     mp.updateKeys(dc, recursive);
     sc.reloadPermissions();

trunk/www/include/menu.jsp

@@ -379 +379 @@
     final boolean hasProjects           = !sc.hasPermission(Permission.DENIED, Item.PROJECT); 
     final boolean createProjects        =  sc.hasPermission(Permission.CREATE, Item.PROJECT); 
+    final boolean hasPermissionTemplates = !sc.hasPermission(Permission.DENIED, Item.PERMISSIONTEMPLATE); 
 
     final boolean hasMessages           = !sc.hasPermission(Permission.DENIED, Item.MESSAGE); 
@@ -437 +438 @@
         tooltip="Manage projects"
         enabled="<%=hasProjects%>"
+      />
+      <m:menuitem
+        title="Permission templates"
+        onclick="<%="Menu.openUrl('"+root+"views/permissiontemplates/index.jsp?ID="+ID+"')"%>"
+        tooltip="Manage permission templates"
+        enabled="<%=hasPermissionTemplates%>"
       />
       <m:menuitem 

trunk/www/include/scripts/main.js

@@ -521 +521 @@
     this.controllers['MESSAGE'] = { url:'my_base/messages/index.jsp', width:600, height:420, popup:true, edit:false };
     this.controllers['PROJECT'] = { url:'my_base/projects/index.jsp', width:600, height:460 };
+    this.controllers['PERMISSIONTEMPLATE'] = { url:'views/permissiontemplates/index.jsp', width:450, height:280 };
     this.controllers['FILE'] = { url:'filemanager/index.jsp', width:560, height:420 };
     this.controllers['FILESERVER'] = { url:'filemanager/fileservers/index.jsp', width:600, height:460 };

trunk/www/my_base/projects/edit_project.jsp

@@ -39 +39 @@
   import="net.sf.basedb.core.Platform"
   import="net.sf.basedb.core.PlatformVariant"
+  import="net.sf.basedb.core.Include"
+  import="net.sf.basedb.core.PermissionTemplate"
   import="net.sf.basedb.core.User"
   import="net.sf.basedb.core.Group"
@@ -93 +95 @@
   String title = null;
   Project project = null;
-
+  
   // Query to retrieve child groups
   ItemQuery<Group> groupQuery = null;
@@ -109 +111 @@
   PlatformVariant currentVariant = null;
   RawDataType currentRawDataType = null;
-  
+  boolean readCurrentPermissionTemplate = true;
+  PermissionTemplate currentPermissionTemplate = null;
+
+  List<PermissionTemplate> recentPermissionTemplates = (List<PermissionTemplate>)cc.getRecent(dc, Item.PERMISSIONTEMPLATE);
+
   if (itemId == 0)
   {
     title = "Create project";
     cc.removeObject("item");
+    currentPermissionTemplate = Base.getFirstMatching(dc, PermissionTemplate.getQuery(), "name", cc.getPropertyFilter("permissionTemplate.name"));
   }
   else
@@ -140 +147 @@
     if (currentRawDataType == null && currentPlatform != null) currentRawDataType = currentPlatform.getRawDataType();
     if (currentRawDataType == null) currentRawDataType = project.getDefaultRawDataType();
-    
+  
+    try
+    {
+      currentPermissionTemplate = project.getPermissionTemplate();
+    }
+    catch (PermissionDeniedException ex)
+    {
+      readCurrentPermissionTemplate = false;
+    }
+  
     groupQuery = project.getGroups();
     groupQuery.include(Include.ALL);
@@ -173 +189 @@
   final String requiredClazz = "class=\"text required\"";
   %>
-
-  <%@page import="net.sf.basedb.core.Include"%>
-<base:page type="popup" title="<%=title%>">
+  <base:page type="popup" title="<%=title%>">
   <base:head scripts="tabcontrol.js,linkitems.js,parameters.js,platforms.js" styles="tabcontrol.css,parameters.css">
     <script language="JavaScript">
@@ -223 +237 @@
       initDefaults();
       platformOnChange();
+      permissionTemplateOnChange();
       showPermissions(frm.autoPermissions.value, 'auto_');
     }
@@ -441 +456 @@
       frm.autoPermissions.value = getPermissionCode('auto_');
     }
-    
+
+    function selectPermissionTemplateOnClick()
+    {
+      var frm = document.forms['project'];
+      var url = '../../views/permissiontemplates/index.jsp?ID=<%=ID%>&cmd=UpdateContext&mode=selectone&callback=setPermissionTemplateCallback';
+      if (frm.permissiontemplate_id.length > 1) 
+      {
+        var id = Math.abs(parseInt(frm.permissiontemplate_id[1].value));
+        url += '&item_id='+id;
+      }
+      Main.openPopup(url, 'SelectPermissionTemplate', 1000, 700);
+    }
+    function setPermissionTemplateCallback(id, name)
+    {
+      var frm = document.forms['project'];
+      var list = frm.permissiontemplate_id;
+      if (list.length < 2 || list[1].value == '0') // >
+      {
+        Forms.addListOption(list, 1, new Option());
+      }
+      list[1].value = id;
+      list[1].text = name;
+      list.selectedIndex = 1;
+      permissionTemplateOnChange();
+    }
+    function permissionTemplateOnChange()
+    {
+      var frm = document.forms['project'];
+      var hasTemplate = frm.permissiontemplate_id.selectedIndex > 0;
+      frm.auto_read.disabled = hasTemplate;
+      frm.auto_use.disabled = hasTemplate;
+      frm.auto_write.disabled = hasTemplate;
+      frm.auto_delete.disabled = hasTemplate;
+      frm.auto_set_owner.disabled = hasTemplate;
+      frm.auto_set_permission.disabled = hasTemplate;
+    }
     function membersOnChange()
     {
@@ -656 +706 @@
         <td class="prompt">Default permissions</td>
         <td>
+          <base:select 
+            id="permissiontemplate_id"
+            clazz="selectionlist"
+            required="false"
+            current="<%=currentPermissionTemplate%>"
+            denied="<%=!readCurrentPermissionTemplate%>"
+            recent="<%=recentPermissionTemplates%>"
+            newitem="<%=project == null%>"
+            unselectedtext="- select a template or specify below -"
+            onselect="selectPermissionTemplateOnClick()"
+            onchange="permissionTemplateOnChange()"
+          />
+        
           <input type="checkbox" checked name="auto_read" onClick="autoPermissionsOnClick('auto_read')">Read<br>
           <input type="checkbox" checked name="auto_use" onClick="autoPermissionsOnClick('auto_use')">Use<br>
@@ -723 +786 @@
     </t:tab>
     
-    <t:tab id="defaults" title="Defaults"  helpid="project.edit.defaults">
+    <t:tab id="defaults" title="Default items"  helpid="project.edit.defaults">
       <table class="form" cellspacing="2" border="0" cellpadding="0" width="100%">        
         <tr valign="top">

trunk/www/my_base/projects/index.jsp

@@ -38 +38 @@
   import="net.sf.basedb.core.ItemResultIterator"
   import="net.sf.basedb.core.Permission"
+  import="net.sf.basedb.core.PermissionTemplate"
   import="net.sf.basedb.core.ItemContext"
   import="net.sf.basedb.core.MultiPermissions"
@@ -133 +134 @@
     // Update the properties on an item (will close the popup)
     ItemContext cc = Base.getAndSetCurrentContext(sc, itemType, null, defaultContext);
+    final int maxRecent = Base.getMaxRecent(sc);
     dc = sc.newDbControl();
     Project project = (Project)cc.getObject("item");
@@ -149 +151 @@
     project.setAutoPermission(PermissionUtil.getPermissions(Values.getInt(request.getParameter("autoPermissions"), 31)));
     project.setDescription(Values.getStringOrNull(request.getParameter("description")));
+    
+    int permissionTemplateId = Values.getInt(request.getParameter("permissiontemplate_id"), -1);
+    if (permissionTemplateId >= 0)  // < 0 = denied or unchanged
+    {
+      PermissionTemplate pt = permissionTemplateId == 0 ? null : PermissionTemplate.getById(dc, permissionTemplateId);
+      project.setPermissionTemplate(pt);
+      if (pt != null) cc.setRecent(pt, maxRecent);
+    }
 
     // Members tab

trunk/www/my_base/projects/list_projects.jsp

@@ -228 +228 @@
         datatype="string"
         title="Owner"
+        sortable="true" 
+        filterable="true"
+        exportable="true"
+      />
+      <tbl:columndef 
+        id="permissionTemplate"
+        property="permissionTemplate.name"
+        datatype="string"
+        title="Default permissions"
         sortable="true" 
         filterable="true"
@@ -419 +428 @@
                     enablePropertyLink="<%=mode.hasPropertyLink()%>"
                   /></tbl:cell>
+                <tbl:cell column="permissionTemplate"
+                  ><base:propertyvalue 
+                    item="<%=item%>" 
+                    property="permissionTemplate"
+                    enableEditLink="<%=mode.hasEditLink()%>" 
+                    enablePropertyLink="<%=mode.hasPropertyLink()%>"
+                    nulltext="<%=PermissionUtil.getFullPermissionNames(item.getAutoPermission())%>"
+                  /></tbl:cell>
                 <tbl:cell column="entryDate" value="<%=item.getEntryDate()%>" />
                 <tbl:cell column="description"><%=HTML.encodeTags(item.getDescription())%></tbl:cell>

trunk/www/my_base/projects/view_project.jsp

@@ -268 +268 @@
       <tr>
         <td class="prompt">Default permissions</td>
-        <td><%=PermissionUtil.getFullPermissionNames(project.getAutoPermission())%></td>
+        <td><base:propertyvalue item="<%=project%>" property="permissionTemplate" 
+          nulltext="<%=PermissionUtil.getFullPermissionNames(project.getAutoPermission())%>" /></td>
       </tr>
       <tr>