Changeset 1425

Timestamp:

03/19/2015 07:31:41 PM (10 years ago)

Author:

ocean90

Message:

Translate: Update Rosetta bridge to reflect new role/permissions system.

see #741.

File:

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

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

@@ -3 +3 @@
  * Tie roles on Rosetta sites directly into translate.wordpress.org.
  *
- * Anyone with the role of Validator, Contributor, Author, or Editor
- * has the ability to validate strings for that language.
- *
- * Future improvements to this would make this more granular (i.e. per-project)
- * with a UI in Rosetta to control those permissions.
- *
- * @author Nacin
+ * @author Nacin, ocean90
  */
 class GP_WPorg_Rosetta_Roles extends GP_Plugin {
-    var $id = 'wporg-rosetta-roles';
-
-    function __construct() {
+    /**
+     * Holds the plugin ID.
+     *
+     * @var string
+     */
+    public $id = 'wporg-rosetta-roles';
+
+    /**
+     * Holds the role of an approver.
+     *
+     * @var string
+     */
+    public $approver_role = 'translation_editor';
+
+    /**
+     * Holds the meta key of the project access list.
+     *
+     * @var string
+     */
+    public $project_access_meta_key = 'translation_editor_project_access_list';
+
+    /**
+     * Contructor.
+     */
+    public function __construct() {
         parent::__construct();
         $this->add_filter( 'pre_can_user', array( 'args' => 2, 'priority' => 9 ) );
     }
 
-    function pre_can_user( $verdict, $args ) {
-        if ( ! class_exists( 'BP_Roles' ) )
+    /**
+     * Filter to check if the current user has permissions to approve strings, based
+     * on a role on the Rosetta site.
+     *
+     * @param string $verdict Verdict.
+     * @param array  $args    Array of arguments.
+     * @return bool True if user has permissions, false if not.
+     */
+    public function pre_can_user( $verdict, $args ) {
+        if ( ! class_exists( 'BP_Roles' ) ) {
             require_once( BACKPRESS_PATH . 'class.bp-roles.php' );
-        if ( ! class_exists( 'BP_User' ) )
+        }
+        if ( ! class_exists( 'BP_User' ) ) {
             require_once( BACKPRESS_PATH . 'class.bp-user.php' );
+        }
+
+        // Current user.
         $user = new BP_User( $args['user_id'] );
 
         // 115 = global.wordpress.org. Administrators on this site are considered global admins in GlotPress.
-        if ( ! empty( $user->wporg_115_capabilities ) && is_array( $user->wporg_115_capabilities ) && ! empty( $user->wporg_115_capabilities['administrator'] ) )
+        if ( ! empty( $user->wporg_115_capabilities ) && is_array( $user->wporg_115_capabilities ) && ! empty( $user->wporg_115_capabilities['administrator'] ) ) {
             return true;
-
-        if ( $args['action'] !== 'approve' || ! in_array( $args['object_type'], array( 'project|locale|set-slug', 'translation-set' ) ) )
-            return false;
- 
-        if ( ! $locale_slug = $this->get_locale_slug( $args['object_type'], $args['object_id'] ) )
-            return false;
-
-        if ( ! $maybe_cap_key = $this->get_cap_key( $locale_slug ) )
-            return false;
-
-        $user->cap_key = $maybe_cap_key;
+        }
+
+        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;
+
+        // Get blog prefix of the associated Rosetta site.
+        if ( ! $blog_prefix = $this->get_blog_prefix( $locale_slug ) ) {
+            return false;
+        }
+
+        // Check if current user has the approver role.
+        $user->cap_key = $blog_prefix . 'capabilities';
         $user->caps = &$user->{$user->cap_key};
-        if ( ! is_array( $user->caps ) )
+        if ( ! is_array( $user->caps ) ) {
             $user->caps = array();
+        }
         $user->get_role_caps();
-        foreach ( array( 'administrator', 'editor', 'author', 'contributor', 'validator' ) as $role ) {
-            if ( $user->has_cap( $role ) )
-                return true;
-        }
+        if ( ! $user->has_cap( $this->approver_role ) ) {
+            return false;
+        }
+
+        // Get IDs of projects which the user can approve.
+        $meta_key =  $blog_prefix . $this->project_access_meta_key;
+        if ( empty( $user->$meta_key ) || ! is_array( $user->$meta_key ) ) {
+            return false;
+        }
+
+        $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;
+        }
+
+        // An user is allowed to approve potential sub projects as well.
+        $projects = $this->get_all_projects(); // Flat array
+        $project_tree = $this->get_project_tree( $projects );
+        $allowed_sub_project_ids = array();
+        foreach ( $project_access_list as $project_id ) {
+            $sub_project_ids = $this->get_sub_project_ids( $project_id, $project_tree );
+            if ( $sub_project_ids ) {
+                $allowed_sub_project_ids = array_merge( $allowed_sub_project_ids, $sub_project_ids );
+            }
+        }
+        $allowed_sub_project_ids = array_unique( $allowed_sub_project_ids );
+
+        if ( in_array( $current_project_id, $allowed_sub_project_ids ) ) {
+            return true;
+        }
+
         return false;
     }
 
-    function get_locale_slug( $object_type, $object_id ) {
+    /**
+     * Fetches all projects from database.
+     *
+     * @return array List of projects with ID and parent ID.
+     */
+    public function get_all_projects() {
+        global $gpdb;
+        static $projects;
+
+        if ( isset( $projects ) ) {
+            return $projects;
+        }
+
+        $table = GP::$project->table;
+
+        $_projects = $gpdb->get_results( "
+            SELECT
+                id, parent_project_id
+            FROM $table
+            ORDER BY id
+        " );
+
+        $projects = array();
+        foreach ( $_projects as $project ) {
+            $projects[ $project->id ] = $project;
+        }
+
+        return $projects;
+    }
+
+    /**
+     * Transforms a flat array to a hierarchy tree.
+     *
+     * @param array $projects  The projects
+     * @param int   $parent_id Optional. Parent ID. Default 0.
+     * @param int   $max_depth Optional. Max depth to avoid endless recursion. Default 5.
+     * @return array The project tree.
+     */
+    public function get_project_tree( $projects, $parent_id = 0, $max_depth = 5 ) {
+        if ( $max_depth < 0 ) { // Avoid an endless recursion.
+            return;
+        }
+
+        $tree = array();
+        foreach ( $projects as $project ) {
+            if ( $project->parent_project_id == $parent_id ) {
+                $sub_projects = $this->get_project_tree( $projects, $project->id, $max_depth - 1 );
+                if ( $sub_projects ) {
+                    $project->sub_projects = $sub_projects;
+                }
+
+                $tree[ $project->id ] = $project;
+                unset( $projects[ $project->id ] );
+            }
+        }
+        return $tree;
+    }
+
+    /**
+     * Returns all sub project IDs of a parent ID.
+     *
+     * @param int   $project_id Parent ID.
+     * @param array $projects   Hierarchy tree of projects.
+     * @return array IDs of the sub projects.
+     */
+    public function get_sub_project_ids( $project_id, $projects ) {
+        $project_branch = $this->get_project_branch( $project_id, $projects );
+        $project_ids = self::array_keys_multi( $project_branch->sub_projects, 'sub_projects' );
+        return $project_ids;
+    }
+
+    /**
+     * Returns a specifc branch of a hierarchy tree.
+     *
+     * @param int   $project_id Project ID.
+     * @param array $projects   Hierarchy tree of projects.
+     * @return mixed False if project ID doesn't exist, project branch on success.
+     */
+    public function get_project_branch( $project_id, $projects ) {
+        if ( ! is_array( $projects ) ) {
+            return false;
+        }
+
+        foreach ( $projects as $project ) {
+            if ( $project->id == $project_id ) {
+                return $project;
+            }
+
+            $sub = $this->get_project_branch( $project_id, $project->sub_projects );
+            if ( $sub ) {
+                return $sub;
+            }
+        }
+
+        return false;
+    }
+
+    /**
+     * Extracts project ID and locale slug from object type and ID.
+     *
+     * @param string $object_type Current object type.
+     * @param string $object_id   Current object ID.
+     * @return array Locale and project ID.
+     */
+    public function get_locale_and_project_id( $object_type, $object_id ) {
         switch ( $object_type ) {
             case 'translation-set' :
-                return GP::$translation_set->get( $object_id )->locale;
-                break;
+                $set = GP::$translation_set->get( $object_id );
+                return array( 'locale' => $set->locale, 'project_id' => (int) $set->project_id );
+
             case 'project|locale|set-slug' :
-                list( , $locale ) = explode( '|', $object_id );
-                return $locale;
-                break;
+                list( $project_id, $locale ) = explode( '|', $object_id );
+                return array( 'locale' => $locale, 'project_id' => (int) $project_id );
         }
         return false;
     }
 
-    function get_cap_key( $locale_slug ) {
+    /**
+     * Returns the blog prefix of a locale.
+     *
+     * @param string $locale_slug Slug of GlotPress locale.
+     * @return bool|string Blog prefix on success, false on failure.
+     */
+    public function get_blog_prefix( $locale_slug ) {
         global $gpdb;
         static $ros_blogs, $ros_locale_assoc;
 
         $gp_locale = GP_Locales::by_slug( $locale_slug );
-        if ( ! $gp_locale || ! isset( $gp_locale->wp_locale ) )
-            return false;
+        if ( ! $gp_locale || ! isset( $gp_locale->wp_locale ) ) {
+            return false;
+        }
 
         $wp_locale = $gp_locale->wp_locale;
 
         if ( ! isset( $ros_blogs ) ) {
-            $ros_locale_assoc = $gpdb->get_results( "SELECT locale, subdomain FROM locales", OBJECT_K );
+            $ros_locale_assoc = $gpdb->get_results( 'SELECT locale, subdomain FROM locales', OBJECT_K );
             // 6 = Rosetta sites
-            $ros_blogs = $gpdb->get_results( "SELECT domain, blog_id FROM wporg_blogs WHERE site_id = 6", OBJECT_K );
-        }
-
-        if ( isset( $ros_locale_assoc[ $wp_locale ] ) )
+            $ros_blogs = $gpdb->get_results( 'SELECT domain, blog_id FROM wporg_blogs WHERE site_id = 6', OBJECT_K );
+        }
+
+        if ( isset( $ros_locale_assoc[ $wp_locale ] ) ) {
             $subdomain = $ros_locale_assoc[ $wp_locale ]->subdomain;
-        else
-            return false;
-
-        if ( isset( $ros_blogs[ "$subdomain.wordpress.org" ] ) )
-            return 'wporg_' . $ros_blogs[ "$subdomain.wordpress.org" ]->blog_id . '_capabilities';
+        } else {
+            return false;
+        }
+
+        if ( isset( $ros_blogs[ "$subdomain.wordpress.org" ] ) ) {
+            return 'wporg_' . $ros_blogs[ "$subdomain.wordpress.org" ]->blog_id . '_';
+        }
 
         return false;
     }
+
+    /**
+     * Returns all keys of a multidimensional array.
+     *
+     * @param array  $array      Multidimensional array to extract keys from.
+     * @param string $childs_key Optional. Key of the child elements. Default 'childs'.
+     * @return array Array keys.
+     */
+    public static function array_keys_multi( $array, $childs_key = 'childs' ) {
+        $keys = array();
+
+        foreach ( $array as $key => $value ) {
+            $keys[] = $key;
+
+            if ( is_array( $value->$childs_key ) ) {
+                $keys = array_merge( $keys, self::array_keys_multi( $value->$childs_key ) );
+            }
+        }
+
+        return $keys;
+    }
 }
+
 GP::$plugins->wporg_rosetta_roles = new GP_WPorg_Rosetta_Roles;