Changeset 1834

Timestamp:

08/19/2015 04:20:40 AM (9 years ago)

Author:

dd32

Message:

Translate: Rosetta Roles: Modularize the checks to make it easier for other GlotPress plugins/templates to customize the UI based on a Translators permissions.

File:

• sites/trunk/translate.wordpress.org/includes/gp-plugins/wporg-rosetta-roles/wporg-rosetta-roles.php (modified) (8 diffs)

sites/trunk/translate.wordpress.org/includes/gp-plugins/wporg-rosetta-roles/wporg-rosetta-roles.php

@@ -52 +52 @@
      */
     public function pre_can_user( $verdict, $args ) {
+        // Administrators on global.wordpress.org are considered global admins in GlotPress.
+        if ( $this->is_global_administrator( $args['user_id'] ) ) {
+            return true;
+        }
+
+        if ( $args['action'] !== 'approve' || ! in_array( $args['object_type'], array( 'project|locale|set-slug', 'translation-set' ) ) ) {
+            return false;
+        }
+
+        // Get locale and current project ID.
+        $locale_and_project_id = (object) $this->get_locale_and_project_id( $args['object_type'], $args['object_id'] );
+        if ( ! $locale_and_project_id ) {
+            return false;
+        }
+
+        $locale_slug = $locale_and_project_id->locale;
+        $current_project_id = $locale_and_project_id->project_id;
+
+        // Simple check to see if they're an approver or not
+        if ( ! $this->is_approver_for_locale( $args['user_id'], $locale_slug ) ) {
+            return false;
+        }
+
+        // Grab the list of Projects (or 'all') that the user can approve
+        $project_access_list = $this->get_project_id_access_list( $args['user_id'], $locale_slug );
+        if ( ! $project_access_list ) {
+            return false;
+        }
+
+        // Short circuit the check if user can approve all projects.
+        if ( in_array( 'all', $project_access_list ) ) {
+            return true;
+        }
+
+        // If current project is a parent ID.
+        if ( in_array( $current_project_id, $project_access_list ) ) {
+            return true;
+        }
+
+        // A user is allowed to approve sub projects as well.
+        $project_access_list = $this->get_project_id_access_list( $args['user_id'], $locale_slug, /* $include_children = */ true );
+        if ( in_array( $current_project_id, $project_access_list ) ) {
+            return true;
+        }
+
+        return false;
+    }
+
+    /**
+     * Determine if a given user is a Global Admin.
+     *
+     * Users present as an administrator on global.wordpress.org are treated as a
+     * global administrator in GlotPress.
+     *
+     * @param int $user A BackPress User object or user ID for the user to check.
+     *
+     * @return bool
+     */
+    public function is_global_administrator( $user_id ) {
         if ( ! class_exists( 'BP_Roles' ) ) {
             require_once( BACKPRESS_PATH . 'class.bp-roles.php' );
@@ -59 +118 @@
         }
 
-        // Current user.
-        $user = new BP_User( $args['user_id'] );
+        $user = new BP_User( $user_id );
 
         // 115 = global.wordpress.org. Administrators on this site are considered global admins in GlotPress.
@@ -67 +125 @@
         }
 
-        if ( $args['action'] !== 'approve' || ! in_array( $args['object_type'], array( 'project|locale|set-slug', 'translation-set' ) ) ) {
-            return false;
-        }
-
-        // Get locale and current project ID.
-        $locale_and_project_id = (object) $this->get_locale_and_project_id( $args['object_type'], $args['object_id'] );
-        if ( ! $locale_and_project_id ) {
-            return false;
-        }
-
-        $locale_slug = $locale_and_project_id->locale;
-        $current_project_id = $locale_and_project_id->project_id;
+        return false;
+    }
+
+    /**
+     * Determine if a given user is a Translation Approver for a Locale.
+     *
+     * @param int $user A BackPress User object or user ID for the user to check.
+     *
+     * @return bool
+     */
+    public function is_approver_for_locale( $user_id, $locale_slug ) {
+        if ( ! class_exists( 'BP_Roles' ) ) {
+            require_once( BACKPRESS_PATH . 'class.bp-roles.php' );
+        }
+        if ( ! class_exists( 'BP_User' ) ) {
+            require_once( BACKPRESS_PATH . 'class.bp-user.php' );
+        }
 
         // Get blog prefix of the associated Rosetta site.
@@ -84 +147 @@
             return false;
         }
+
+        $user = new BP_User( $user_id );
 
         // Check if current user has the approver role.
@@ -92 +157 @@
         }
         $user->get_role_caps();
-        if ( ! $user->has_cap( $this->approver_role ) ) {
+
+        return $user->has_cap( $this->approver_role );
+
+    }
+
+    /**
+     * Retrieve a list of Project ID's which the current user can approve for.
+     *
+     * This is likely to be incorrrect in the event that the user is a Translation Editor or Global Admin.
+     * The array item 'all' is special, which means to allow access to all projects.
+     *
+     * @param int    $user            A BackPress User object or user ID for the user to check.
+     * @param string $locale_slug     The Locale for which we are checking
+     * @param int    $include_children Whether to include the children project ID's in the return
+     *
+     * @return array A list of the Project ID's for which the current user can approve translations for.
+     */
+    public function get_project_id_access_list( $user_id, $locale_slug, $include_children = false ) {
+        if ( ! class_exists( 'BP_Roles' ) ) {
+            require_once( BACKPRESS_PATH . 'class.bp-roles.php' );
+        }
+        if ( ! class_exists( 'BP_User' ) ) {
+            require_once( BACKPRESS_PATH . 'class.bp-user.php' );
+        }
+
+        $user = new BP_User( $user_id );
+
+        // Get blog prefix of the associated Rosetta site.
+        if ( ! $blog_prefix = $this->get_blog_prefix( $locale_slug ) ) {
             return false;
         }
 
         // Get IDs of projects which the user can approve.
-        $meta_key =  $blog_prefix . $this->project_access_meta_key;
+        $meta_key = $blog_prefix . $this->project_access_meta_key;
         if ( empty( $user->$meta_key ) || ! is_array( $user->$meta_key ) ) {
             return false;
@@ -104 +197 @@
         $project_access_list = $user->$meta_key;
 
-        // Short circuit the check if user can approve all projects.
-        if ( in_array( 'all', $project_access_list ) ) {
-            return true;
-        }
-
-        // If current project is a parent ID.
-        if ( in_array( $current_project_id, $project_access_list ) ) {
-            return true;
+        // If we don't want the children, or the user has access to all projects.
+        if ( ! $include_children || in_array( 'all', $project_access_list ) ) {
+            return $project_access_list;
         }
 
@@ -117 +205 @@
         $allowed_sub_project_ids = array();
         foreach ( $project_access_list as $project_id ) {
+            if ( 'all' === $project_id ) {
+                continue;
+            }
             $sub_project_ids = $this->get_sub_project_ids( $project_id );
             if ( $sub_project_ids ) {
@@ -122 +213 @@
             }
         }
-        $allowed_sub_project_ids = array_unique( $allowed_sub_project_ids );
-
-        if ( in_array( $current_project_id, $allowed_sub_project_ids ) ) {
-            return true;
-        }
-
-        return false;
+
+        $project_access_list = array_merge( $project_access_list, $allowed_sub_project_ids );
+        $project_access_list = array_unique( $project_access_list );
+
+        return $project_access_list;
     }