Changeset 7299

Timestamp:

Feb 22, 2017, 12:59:59 PM (7 years ago)

Author:

Nicklas Nordborg

Message:

References #2056: Improve API for project-specific annotations

Changed API methods related to this to take a Project parameter instead of the numeric ID. This is to avoid permission issues that would make it possible to create annotations for projects that the logged in user is not a member of.

Location:

trunk/src

Files:

• core/net/sf/basedb/core/AnnotationBatcher.java (modified) (2 diffs)
• core/net/sf/basedb/core/AnnotationSet.java (modified) (11 diffs)
• core/net/sf/basedb/core/snapshot/SnapshotManager.java (modified) (2 diffs)
• test/TestAnnotation.java (modified) (1 diff)

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

@@ -172 +172 @@
   private final Map<String, UnitConverter> unitConvertes;
   
+  /**
+    Create a new batcher instance. Using this constructor creates a batcher
+    that, for project-specific annotation types, automatically handles either
+    the default or project-specific value depending on the currently active 
+    project and wheter a value already exists or not.
+     
+    @param dc A DbControl to use for database access
+    @param itemType The type of items to work with. This must be an annotatable item type.
+  */
   public AnnotationBatcher(DbControl dc, Item itemType)
   {
-    this(dc, itemType, null);
-  }
-  
+    this(dc, itemType, (Integer)null);
+  }
+  
+  /**
+    Create a new batcher instance. Using this constructor creates a batcher
+    that, for project-specific annotation types, always work with the values
+    for the given project (or the default values if project=null). The currently
+    active project is ignored.
+     
+    @param dc A DbControl to use for database access
+    @param itemType The type of items to work with. This must be an annotatable item type.
+    @param project Specify a project to only consider values for that project
+      when working with a project-specific annotation, or null to only consider default
+      values
+    @since 3.11
+  */
+  public AnnotationBatcher(DbControl dc, Item itemType, Project project)
+  {
+    this(dc, itemType, project == null ? 0 : project.getId());
+  }
+
   /**
     Create a new batcher instance. 
@@ -188 +215 @@
   */
   @SuppressWarnings({ "unchecked", "rawtypes" })
-  public AnnotationBatcher(DbControl dc, Item itemType, Integer projectId)
+  private AnnotationBatcher(DbControl dc, Item itemType, Integer projectId)
   {
     if (dc == null) throw new NullPointerException("dc");

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

@@ -602 +602 @@
   
   /**
-    Get a value for a project-specific annotation using the specified project id instead
+    Get a value for a project-specific annotation using the specified project instead
     of the currently active project. Note that this method behaves differently than
     the {@link #getAnnotation(AnnotationType)} method.
     
-     * If the annotation type is not using project annotation, the project id is ignored
-     * If projectId=0 the default annotation  value is returned (new or existing)
-     * If projectId!=0 a project-specific annotation value is returned (new or existing,
+     * If the annotation type is not using project annotations, the project is ignored
+     * If project=null the default annotation  value is returned (new or existing)
+     * If project!=null a project-specific annotation value is returned (new or existing,
        the default value is never returned)
        
@@ -617 +617 @@
 
     @param annotationType The annotation type
-    @param projectId The project id or 0 to get the default value
+    @param project A project or null to get the default value
     @since 3.11
   */
-  public Annotation getProjectAnnotation(AnnotationType annotationType, int projectId)
+  public Annotation getProjectAnnotation(AnnotationType annotationType, Project project)
   {
     if (annotationType == null) throw new InvalidUseOfNullException("annotationType");
@@ -626 +626 @@
     
     int primary = Annotation.Source.PRIMARY.ordinal();
-    if (!annotationType.getProjectAnnotations()) projectId = 0;
+    int projectId = annotationType.getProjectAnnotations() && project != null ? project.getId() : 0;
 
     // Search for an existing primary annotation
@@ -734 +734 @@
     @param annotationType An <code>AnnotationType</code> object
     @param source The source type of the annotation or null if it doesn't matter
-    @param projectId The project id or 0 to get the default value
+    @param project A project or null to check for the default value
     
     @return TRUE if the annotation set contains an annotation of 
@@ -740 +740 @@
     @since 3.11
   */
-  public boolean hasProjectAnnotation(AnnotationType annotationType, Annotation.Source source, int projectId)
+  public boolean hasProjectAnnotation(AnnotationType annotationType, Annotation.Source source, Project project)
   {
     if (annotationType == null) return false;
     
     DbControl dc = getDbControl();
-    if (!annotationType.getProjectAnnotations()) projectId = 0;
+    int projectId = annotationType.getProjectAnnotations() && project != null ? project.getId() : 0;
     
     AnnotationTypeData atd = annotationType.getData();
@@ -780 +780 @@
     throws PermissionDeniedException, InvalidDataException, BaseException
   {
-    removeProjectAnnotation(annotationType, getSessionControl().getActiveProjectId());
+    int projectId = getSessionControl().getActiveProjectId();
+    removeProjectAnnotation(annotationType, projectId == 0 ? null : Project.getById(getDbControl(), projectId));
   }
   
@@ -791 +792 @@
     
     @param annotationType The type of the annotation to delete
-    @param projectId The project id or 0 to remove the default value
+    @param project A project or null to remove the default value
     @throws PermissionDeniedException If the logged in user
       doesn't have write permission
@@ -798 +799 @@
     @since 3.11
   */
-  public void removeProjectAnnotation(AnnotationType annotationType, int projectId)
+  public void removeProjectAnnotation(AnnotationType annotationType, Project project)
     throws PermissionDeniedException, InvalidDataException, BaseException
   {
@@ -804 +805 @@
     if (annotationType == null) throw new InvalidUseOfNullException("annotationType");
     annotationType.checkPermission(Permission.USE);
-    if (!annotationType.getProjectAnnotations()) projectId = 0;
+    int projectId = annotationType.getProjectAnnotations() && project != null ? project.getId() : 0;
     
     DbControl dc = getDbControl();
@@ -867 +868 @@
   
     @param source A source or null to not filter on source
-    @param projectId The project id or 0 to query default values
+    @param project The project or null to query default values
     @since 3.11
   */
-  public ItemQuery<Annotation> getProjectAnnotations(Annotation.Source source, int projectId)
+  public ItemQuery<Annotation> getProjectAnnotations(Annotation.Source source, Project project)
   {
     ItemQuery<Annotation> query = Annotation.getQuery();
@@ -881 +882 @@
       Restrictions.eq(
         Hql.property("projectId"), 
-        Expressions.integer(projectId)
+        Expressions.integer(project != null ? project.getId() : 0)
     ));
     if (source != null)

trunk/src/core/net/sf/basedb/core/snapshot/SnapshotManager.java

@@ -37 +37 @@
 import net.sf.basedb.core.DbControl;
 import net.sf.basedb.core.Permission;
+import net.sf.basedb.core.Project;
 import net.sf.basedb.util.StaticCache;
 import net.sf.basedb.util.filter.Filter;
@@ -121 +122 @@
   
   /**
-    When a project id is set, the snapshot manager will only 
+    When a project is set, the snapshot manager will only 
     search for project-specific annotations explicitely belonging
-    to that project (or default values if projectId=0).
-    
-    Note that this parameter typically always need to be off (=null)
-    when searching for annotations to an annotation type that
-    doesn't have enabled project-specific annotations.
-    
-    @param projectId The project id or 0 to only search for default
-      values or null to revert to the default behaviour 
-      (which load default values if a project-specific values
+    to that project (or default values if project == null).
+    
+    Note that this option typically always need to be off 
+    ({@link #setNoProject()}) when searching for annotations to an 
+    annotation type that doesn't have enabled project-specific annotations.
+    
+    Calling this method with a null parameter IS NOT the same
+    as calling {@link #setNoProject()}.
+    
+    @param project The project or null to only search for default
+      values. Use {@link #setNoProject()} to revert to the default
+      behaviour (which load default values if a project-specific values
       doesn't exists)
     @since 3.11
   */
-  public void setProjectId(Integer projectId)
-  {
-    this.projectId = projectId;
+  public void setProject(Project project)
+  {
+    this.projectId = project == null ? 0 : project.getId();
+  }
+  
+  /**
+    Revert to the default bahavior for loading project-specific annotations.
+    
+    @since 3.11
+  */
+  public void setNoProject()
+  {
+    this.projectId = null;
   }
   

trunk/src/test/TestAnnotation.java

@@ -281 +281 @@
       Annotatable annotatable = (Annotatable)itemType.getById(dc, itemId);
       AnnotationType at = AnnotationType.getById(dc, annotationTypeId);
+      Project project = projectId == 0 ? null : Project.getById(dc, projectId);
 
       AnnotationSet as = annotatable.getAnnotationSet();
-      Annotation a = as.getProjectAnnotation(at, projectId);
+      Annotation a = as.getProjectAnnotation(at, project);
       
       if (value != null)