<!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>[1834] sites/trunk/translate.wordpress.org/includes/gp-plugins/wporg-rosetta-roles/wporg-rosetta-roles.php: Translate: Rosetta Roles: Modularize the checks to make it easier for other GlotPress plugins/templates to customize the UI based on a Translators permissions.</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/1834">1834</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/1834","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>dd32</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2015-08-19 04:20:40 +0000 (Wed, 19 Aug 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: Rosetta Roles: Modularize the checks to make it easier for other GlotPress plugins/templates to customize the UI based on a Translators permissions.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#sitestrunktranslatewordpressorgincludesgppluginswporgrosettaroleswporgrosettarolesphp">sites/trunk/translate.wordpress.org/includes/gp-plugins/wporg-rosetta-roles/wporg-rosetta-roles.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="sitestrunktranslatewordpressorgincludesgppluginswporgrosettaroleswporgrosettarolesphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: 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/translate.wordpress.org/includes/gp-plugins/wporg-rosetta-roles/wporg-rosetta-roles.php 2015-08-19 03:42:45 UTC (rev 1833)
+++ sites/trunk/translate.wordpress.org/includes/gp-plugins/wporg-rosetta-roles/wporg-rosetta-roles.php 2015-08-19 04:20:40 UTC (rev 1834)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -51,6 +51,65 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @return bool True if user has permissions, false if not.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function pre_can_user( $verdict, $args ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // 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 ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( ! class_exists( 'BP_Roles' ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> require_once( BACKPRESS_PATH . 'class.bp-roles.php' );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -58,32 +117,38 @@
</span><span class="cx" style="display: block; padding: 0 10px"> require_once( BACKPRESS_PATH . 'class.bp-user.php' );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Current user.
- $user = new BP_User( $args['user_id'] );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $user = new BP_User( $user_id );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // 115 = global.wordpress.org. Administrators on this site are considered global admins in GlotPress.
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! empty( $user->wporg_115_capabilities ) && is_array( $user->wporg_115_capabilities ) && ! empty( $user->wporg_115_capabilities['administrator'] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return true;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( $args['action'] !== 'approve' || ! in_array( $args['object_type'], array( 'project|locale|set-slug', 'translation-set' ) ) ) {
- return false;
- }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return false;
+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // 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;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * 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' );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! class_exists( 'BP_User' ) ) {
+ require_once( BACKPRESS_PATH . 'class.bp-user.php' );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $locale_slug = $locale_and_project_id->locale;
- $current_project_id = $locale_and_project_id->project_id;
-
</del><span class="cx" style="display: block; padding: 0 10px"> // Get blog prefix of the associated Rosetta site.
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! $blog_prefix = $this->get_blog_prefix( $locale_slug ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return false;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $user = new BP_User( $user_id );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // Check if current user has the approver role.
</span><span class="cx" style="display: block; padding: 0 10px"> $user->cap_key = $blog_prefix . 'capabilities';
</span><span class="cx" style="display: block; padding: 0 10px"> $user->caps = &$user->{$user->cap_key};
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -91,43 +156,67 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $user->caps = array();
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> $user->get_role_caps();
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( ! $user->has_cap( $this->approver_role ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ 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 ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> return false;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Get IDs of projects which the user can approve.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $meta_key = $blog_prefix . $this->project_access_meta_key;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $meta_key = $blog_prefix . $this->project_access_meta_key;
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( empty( $user->$meta_key ) || ! is_array( $user->$meta_key ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return false;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $project_access_list = $user->$meta_key;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Short circuit the check if user can approve all projects.
- if ( in_array( 'all', $project_access_list ) ) {
- return true;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // 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;
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // If current project is a parent ID.
- if ( in_array( $current_project_id, $project_access_list ) ) {
- return true;
- }
-
</del><span class="cx" style="display: block; padding: 0 10px"> // A user is allowed to approve sub projects as well.
</span><span class="cx" style="display: block; padding: 0 10px"> $allowed_sub_project_ids = array();
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $project_access_list as $project_id ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( 'all' === $project_id ) {
+ continue;
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> $sub_project_ids = $this->get_sub_project_ids( $project_id );
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $sub_project_ids ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $allowed_sub_project_ids = array_merge( $allowed_sub_project_ids, $sub_project_ids );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $allowed_sub_project_ids = array_unique( $allowed_sub_project_ids );
</del><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( in_array( $current_project_id, $allowed_sub_project_ids ) ) {
- return true;
- }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $project_access_list = array_merge( $project_access_list, $allowed_sub_project_ids );
+ $project_access_list = array_unique( $project_access_list );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return false;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return $project_access_list;
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span></span></pre>
</div>
</div>
</body>
</html>