<!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>[2265] sites/trunk/wordpress.org/public_html/wp-content/plugins: Translate: Convert the GP plugin "wporg-log-warnings-to-slack" 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/2265">2265</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/2265","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>2016-01-10 00:24:19 +0000 (Sun, 10 Jan 2016)</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-log-warnings-to-slack" 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-slack-integrations/</li>
<li>sites/trunk/wordpress.org/public_html/wp-content/plugins/wporg-gp-slack-integrations/integrations/</li>
<li><a href="#sitestrunkwordpressorgpublic_htmlwpcontentpluginswporggpslackintegrationsintegrationslogwarningsphp">sites/trunk/wordpress.org/public_html/wp-content/plugins/wporg-gp-slack-integrations/integrations/log-warnings.php</a></li>
<li><a href="#sitestrunkwordpressorgpublic_htmlwpcontentpluginswporggpslackintegrationswporggpslackintegrationsphp">sites/trunk/wordpress.org/public_html/wp-content/plugins/wporg-gp-slack-integrations/wporg-gp-slack-integrations.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="sitestrunkwordpressorgpublic_htmlwpcontentpluginswporggpslackintegrationsintegrationslogwarningsphp"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: sites/trunk/wordpress.org/public_html/wp-content/plugins/wporg-gp-slack-integrations/integrations/log-warnings.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-slack-integrations/integrations/log-warnings.php (rev 0)
+++ sites/trunk/wordpress.org/public_html/wp-content/plugins/wporg-gp-slack-integrations/integrations/log-warnings.php 2016-01-10 00:24:19 UTC (rev 2265)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,139 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+/**
+ * Logs translation warnings into a public slack channel for peer-review.
+ *
+ * @author @dd32
+ */
+class WPorg_GP_Slack_Log_Warnings {
+
+ /**
+ * Holds the channels name to send notifcations too.
+ *
+ * @var string
+ */
+ private $channel = '#polyglots-warnings';
+
+ /**
+ * Holds the list of Translation ID's which have been
+ * notified about in this process.
+ *
+ * @var array
+ */
+ private $warned = array();
+
+ public function __construct() {
+ if ( ! defined( 'GLOTPRESS_SLACK_WEBHOOK' ) ) {
+ return;
+ }
+
+ add_action( 'warning_discarded', array( $this, 'warning_discarded' ), 10, 5 );
+ add_action( 'translation_created', array( $this, 'translation_created' ) );
+ add_action( 'translation_saved', array( $this, 'translation_saved' ) );
+ }
+
+ /**
+ * Logs discared warnings into Slack
+ *
+ * @param int $project_id ID of the project.
+ * @param int $translation_set ID if the translation set.
+ * @param int $translation ID of the translation.
+ * @param string $warning Key of the warning. (length, tags, placeholders, both_begin_end_on_newlines)
+ * @param int $user ID of the user.
+ */
+ function warning_discarded( $project_id, $translation_set, $translation, $warning, $user ) {
+ // TODO Log it.
+ }
+
+ /**
+ * Logs translation warnings into Slack for any newly created translations.
+ *
+ * @param GP_Translation $translatiom The just-created translation.
+ */
+ function translation_created( $translation ) {
+ if ( ! $translation->warnings ) {
+ return;
+ }
+
+ // We only want to trigger for strings which are live, or are for consideration.
+ if ( ! in_array( $translation->status, array( 'current', 'waiting' ) ) ) {
+ return;
+ }
+
+ $this->process_translation_warning( $translation );
+ }
+
+ /**
+ * Logs translation warnings into Slack for any existing translations that are updated.
+ *
+ * @param GP_Translation $translatiom The just-created translation.
+ */
+ function translation_saved( $translation ) {
+ if ( ! $translation->warnings ) {
+ return;
+ }
+
+ // We only want to trigger for strings which are live, or are for consideration.
+ if ( ! in_array( $translation->status, array( 'current', 'waiting' ) ) ) {
+ return;
+ }
+
+ $this->process_translation_warning( $translation );
+ }
+
+ /**
+ * Logs translation warnings into Slack.
+ *
+ * @param GP_Translation $translatiom The just-created translation.
+ */
+ function process_translation_warning( $translation ) {
+ // Avoid processing a specific translation twice
+ if ( isset( $this->warned[ $translation->id ] ) ) {
+ return;
+ }
+
+ $this->warned[ $translation->id ] = true;
+
+ $original = GP::$original->get( $translation->original_id );
+ $set = GP::$translation_set->get( $translation->translation_set_id );
+ $project = GP::$project->get( $original->project_id );
+
+ $project_name = $project->name;
+ $parent_project_id = $project->parent_project_id;
+ while ( $parent_project_id ) {
+ $parent_project = GP::$project->get( $parent_project_id );
+ $parent_project_id = $parent_project->parent_project_id;
+ $project_name = "{$parent_project->name} - {$project_name}";
+ }
+
+ $project_url = gp_url_join( gp_url_public_root(), 'projects', $project->path, $set->locale, '/', $set->slug ) . '?filters[warnings]=yes&sort[by]=translation_date_added';
+ $translation_url = gp_url_join( gp_url_public_root(), 'projects', $project->path, $set->locale, '/', $set->slug ) . '?filters[status]=either&filters[original_id]=' . $original->id . '&filters[translation_id]=' . $translation->id;
+
+ $message = "New <{$translation_url}|translation warning> for <{$project_url}|{$project_name}> in {$set->name} #{$set->locale}:\n";
+
+ // GlotPress stores warnings as an array of [ translation_plural => [ warning_code => warning_string ], ... ]
+ foreach ( $translation->warnings as $i => $warn ) {
+ $warnings = implode( ' ', $warn );
+ $original_string = $i ? $original->plural : $original->singular;
+
+ $translation_key = "translation_{$i}";
+ $translation_string = $translation->$translation_key;
+
+ $message .= "*Warning:* {$warnings}\n\t*Original:* {$original_string}\n\t*Translation:* {$translation_string}\n";
+ }
+
+ $this->slack( $message );
+ }
+
+ /**
+ * Sends a notifcation to the the Slack channel.
+ *
+ * @param string $message Text of the notifcation.
+ */
+ function slack( $message ) {
+ require_once API_WPORGPATH . 'includes/slack-config.php';
+ $send = new \Dotorg\Slack\Send( GLOTPRESS_SLACK_WEBHOOK );
+ $send->set_username( 'Translate Warning' );
+ $send->set_text( $message );
+ $send->send( $this->channel );
+ }
+}
</ins></span></pre></div>
<a id="sitestrunkwordpressorgpublic_htmlwpcontentpluginswporggpslackintegrationswporggpslackintegrationsphp"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: sites/trunk/wordpress.org/public_html/wp-content/plugins/wporg-gp-slack-integrations/wporg-gp-slack-integrations.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-slack-integrations/wporg-gp-slack-integrations.php (rev 0)
+++ sites/trunk/wordpress.org/public_html/wp-content/plugins/wporg-gp-slack-integrations/wporg-gp-slack-integrations.php 2016-01-10 00:24:19 UTC (rev 2265)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,39 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+/**
+ * Plugin name: GlotPress: Slack integrations for translate.wordpress.org.
+ * Plugin author: dd32, ocean90
+ */
+
+require_once __DIR__ . '/integrations/log-warnings.php';
+
+class WPorg_GP_Slack_Integrations {
+
+ /**
+ * Holds the logger for warnings instance.
+ *
+ * @var WPorg_GP_Slack_Log_Warnings
+ */
+ public $log_warnings;
+
+ public function __construct() {
+ add_action( 'gp_init', array( $this, 'init_integrations' ) );
+ }
+
+ /**
+ * Initializes custom Slack integrations.
+ */
+ public function init_integrations() {
+ $this->log_warnings = new WPorg_GP_Slack_Log_Warnings();
+ }
+}
+
+function wporg_gp_slack_integrations() {
+ global $wporg_gp_slack_integrations;
+
+ if ( ! isset( $wporg_gp_slack_integrations ) ) {
+ $wporg_gp_slack_integrations = new WPorg_GP_Slack_Integrations();
+ }
+
+ return $wporg_gp_slack_integrations;
+}
+add_action( 'plugins_loaded', 'wporg_gp_slack_integrations' );
</ins></span></pre>
</div>
</div>
</body>
</html>