<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[2110] sites/trunk/wordpress.org/public_html/wp-content/plugins: Translate: Convert the GP plugin "wporg-rosetta-roles" to a WP plugin.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="http://meta.trac.wordpress.org/changeset/2110">2110</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"http://meta.trac.wordpress.org/changeset/2110","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>ocean90</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2015-11-22 21:20:57 +0000 (Sun, 22 Nov 2015)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Translate: Convert the GP plugin "wporg-rosetta-roles" to a WP plugin.
See <a href="http://meta.trac.wordpress.org/ticket/1352">#1352</a>.</pre>
<h3>Added Paths</h3>
<ul>
<li>sites/trunk/wordpress.org/public_html/wp-content/plugins/wporg-gp-rosetta-roles/</li>
<li><a href="#sitestrunkwordpressorgpublic_htmlwpcontentpluginswporggprosettaroleswporggprosettarolesphp">sites/trunk/wordpress.org/public_html/wp-content/plugins/wporg-gp-rosetta-roles/wporg-gp-rosetta-roles.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="sitestrunkwordpressorgpublic_htmlwpcontentpluginswporggprosettaroleswporggprosettarolesphpfromrev2102sitestrunktranslatewordpressorgincludesgppluginswporgrosettaroleswporgrosettarolesphp"></a>
<div class="copfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Copied: sites/trunk/wordpress.org/public_html/wp-content/plugins/wporg-gp-rosetta-roles/wporg-gp-rosetta-roles.php (from rev 2102, sites/trunk/translate.wordpress.org/includes/gp-plugins/wporg-rosetta-roles/wporg-rosetta-roles.php)</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- sites/trunk/wordpress.org/public_html/wp-content/plugins/wporg-gp-rosetta-roles/wporg-gp-rosetta-roles.php (rev 0)
+++ sites/trunk/wordpress.org/public_html/wp-content/plugins/wporg-gp-rosetta-roles/wporg-gp-rosetta-roles.php 2015-11-22 21:20:57 UTC (rev 2110)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,422 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+/**
+ * Plugin name: GlotPress: Tie roles on Rosetta sites directly into translate.wordpress.org.
+ * Plugin author: nacin, ocean90
+ */
+
+class WPorg_GP_Rosetta_Roles {
+
+ /**
+ * Cache group.
+ *
+ * @var string
+ */
+ public $cache_group = 'wporg-translate';
+
+ /**
+ * 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() {
+ add_filter( 'gp_pre_can_user', array( $this, 'pre_can_user' ), 9 , 2 );
+ add_action( 'gp_project_created', array( $this, 'project_created' ) );
+ add_action( 'gp_project_saved', array( $this, 'project_saved' ) );
+ }
+
+ /**
+ * 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 ) {
+ // 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;
+ }
+
+ /**
+ * Callback for when a project is created.
+ */
+ public function project_created() {
+ $this->clear_project_cache();
+ }
+
+ /**
+ * Callback for when a project is saved.
+ */
+ public function project_saved() {
+ $this->clear_project_cache();
+ }
+
+ /**
+ * 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 ) {
+ $user = get_user_by( 'id', $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'] ) ) {
+ return true;
+ }
+
+ 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 ) {
+ // Get blog prefix of the associated Rosetta site.
+ if ( ! $blog_prefix = $this->get_blog_prefix( $locale_slug ) ) {
+ return false;
+ }
+
+ $user = get_user_by( 'id', $user_id );
+
+ // 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 ) ) {
+ $user->caps = array();
+ }
+ $user->get_role_caps();
+
+ 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 ) {
+ $user = get_user_by( 'id', $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;
+ if ( empty( $user->$meta_key ) || ! is_array( $user->$meta_key ) ) {
+ return false;
+ }
+
+ $project_access_list = $user->$meta_key;
+
+ // 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;
+ }
+
+ // A user is allowed to approve sub projects as well.
+ $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 ) {
+ $allowed_sub_project_ids = array_merge( $allowed_sub_project_ids, $sub_project_ids );
+ }
+ }
+
+ // $project_access_list contains parent project IDs, merge them with the sub-project IDs.
+ $project_access_list = array_merge( $project_access_list, $allowed_sub_project_ids );
+
+ return $project_access_list;
+ }
+
+ /**
+ * Fetches all projects from database.
+ *
+ * @return array List of projects with ID and parent ID.
+ */
+ public function get_all_projects() {
+ global $wpdb;
+ static $projects = null;
+
+ if ( null !== $projects ) {
+ return $projects;
+ }
+
+ $_projects = $wpdb->get_results( "
+ SELECT
+ id, parent_project_id
+ FROM {$wpdb->gp_projects}
+ ORDER BY id
+ " );
+
+ $projects = array();
+ foreach ( $_projects as $project ) {
+ $project->sub_projects = array();
+ $projects[ $project->id ] = $project;
+ }
+
+ return $projects;
+ }
+
+ /**
+ * Returns projects as a hierarchy tree.
+ *
+ * @return array The project tree.
+ */
+ public function get_project_tree() {
+ static $project_tree = null;
+
+ if ( null !== $project_tree ) {
+ return $project_tree;
+ }
+
+ $projects = $this->get_all_projects();
+
+ $project_tree = array();
+ foreach ( $projects as $project_id => $project ) {
+ $projects[ $project->parent_project_id ]->sub_projects[ $project_id ] = &$projects[ $project_id ];
+ if ( ! $project->parent_project_id ) {
+ $project_tree[ $project_id ] = &$projects[ $project_id ];
+ }
+ }
+
+ return $project_tree;
+ }
+
+ /**
+ * Returns all sub project IDs of a parent ID.
+ *
+ * @param int $project_id Parent ID.
+ * @return array IDs of the sub projects.
+ */
+ public function get_sub_project_ids( $project_id ) {
+ $cache_key = 'project:' . $project_id . ':childs';
+ $cache = wp_cache_get( $cache_key, $this->cache_group );
+ if ( false !== $cache ) {
+ return $cache;
+ }
+
+ $project_tree = $this->get_project_tree();
+ $project_branch = $this->get_project_branch( $project_id, $project_tree );
+
+ $project_ids = array();
+ if ( isset( $project_branch->sub_projects ) ) {
+ $project_ids = self::array_keys_multi( $project_branch->sub_projects, 'sub_projects' );
+ }
+
+ wp_cache_set( $cache_key, $project_ids, $this->cache_group );
+
+ return $project_ids;
+ }
+
+ /**
+ * Returns a specific 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;
+ }
+
+ if ( isset( $project->sub_projects ) ) {
+ $sub = $this->get_project_branch( $project_id, $project->sub_projects );
+ if ( $sub ) {
+ return $sub;
+ }
+ }
+ }
+
+ return false;
+ }
+
+ /**
+ * Removes all of the project ids from the cache.
+ */
+ public function clear_project_cache() {
+ $projects = $this->get_all_projects();
+
+ foreach ( $projects as $project ) {
+ $cache_key = 'project:' . $project->id . ':childs';
+ wp_cache_delete( $cache_key, $this->cache_group );
+ }
+ }
+
+ /**
+ * 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' :
+ $set = GP::$translation_set->get( $object_id );
+ return array( 'locale' => $set->locale, 'project_id' => (int) $set->project_id );
+
+ case 'project|locale|set-slug' :
+ list( $project_id, $locale ) = explode( '|', $object_id );
+ return array( 'locale' => $locale, 'project_id' => (int) $project_id );
+ }
+ return false;
+ }
+
+ /**
+ * 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 $wpdb;
+ static $ros_blogs, $ros_locale_assoc;
+
+ $gp_locale = GP_Locales::by_slug( $locale_slug );
+ if ( ! $gp_locale || ! isset( $gp_locale->wp_locale ) ) {
+ return false;
+ }
+
+ $wp_locale = $gp_locale->wp_locale;
+
+ if ( ! isset( $ros_blogs ) ) {
+ $ros_locale_assoc = $wpdb->get_results( 'SELECT locale, subdomain FROM locales', OBJECT_K );
+ // 6 = Rosetta sites
+ $ros_blogs = $wpdb->get_results( "SELECT domain, blog_id FROM $wpdb->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 . '_';
+ }
+
+ 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 ( isset( $value->$childs_key ) && is_array( $value->$childs_key ) ) {
+ $keys = array_merge( $keys, self::array_keys_multi( $value->$childs_key ) );
+ }
+ }
+
+ return $keys;
+ }
+}
+
+function wporg_gp_rosetta_roles() {
+ global $wporg_gp_rosetta_roles;
+
+ if ( ! isset( $wporg_gp_rosetta_roles ) ) {
+ $wporg_gp_rosetta_roles = new WPorg_GP_Rosetta_Roles();
+ }
+
+ return $wporg_gp_rosetta_roles;
+}
+add_action( 'plugins_loaded', 'wporg_gp_rosetta_roles' );
</ins></span></pre>
</div>
</div>
</body>
</html>