<!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>[12337] sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory: Plugin Directory: Add initial plugin categorization features to 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 { white-space: pre-line; 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/12337">12337</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/12337","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>coffee2code</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2022-12-15 18:08:03 +0000 (Thu, 15 Dec 2022)</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'>Plugin Directory: Add initial plugin categorization features to plugin.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#sitestrunkwordpressorgpublic_htmlwpcontentpluginsplugindirectoryapiclassbasephp">sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/api/class-base.php</a></li>
<li><a href="#sitestrunkwordpressorgpublic_htmlwpcontentpluginsplugindirectoryclassplugindirectoryphp">sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/class-plugin-directory.php</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li><a href="#sitestrunkwordpressorgpublic_htmlwpcontentpluginsplugindirectoryapiroutesclassplugincategorizationphp">sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/api/routes/class-plugin-categorization.php</a></li>
<li><a href="#sitestrunkwordpressorgpublic_htmlwpcontentpluginsplugindirectorywidgetsclasscategorizationphp">sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/widgets/class-categorization.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="sitestrunkwordpressorgpublic_htmlwpcontentpluginsplugindirectoryapiclassbasephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/api/class-base.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/plugin-directory/api/class-base.php 2022-12-15 17:57:02 UTC (rev 12336)
+++ sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/api/class-base.php 2022-12-15 18:08:03 UTC (rev 12337)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -35,6 +35,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> new Routes\Plugin_Self_Transfer();
</span><span class="cx" style="display: block; padding: 0 10px"> new Routes\Plugin_Release_Confirmation();
</span><span class="cx" style="display: block; padding: 0 10px"> new Routes\Plugin_E2E_Callback();
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ new Routes\Plugin_Categorization();
</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>
<a id="sitestrunkwordpressorgpublic_htmlwpcontentpluginsplugindirectoryapiroutesclassplugincategorizationphp"></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/plugin-directory/api/routes/class-plugin-categorization.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/plugin-directory/api/routes/class-plugin-categorization.php (rev 0)
+++ sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/api/routes/class-plugin-categorization.php 2022-12-15 18:08:03 UTC (rev 12337)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,134 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+namespace WordPressdotorg\Plugin_Directory\API\Routes;
+
+use WordPressdotorg\Plugin_Directory\Plugin_Directory;
+use WordPressdotorg\Plugin_Directory\Template;
+use WordPressdotorg\Plugin_Directory\Tools;
+use WordPressdotorg\Plugin_Directory\API\Base;
+use WP_REST_Server;
+use WP_Error;
+use WP_User;
+
+/**
+ * An API Endpoint to manage plugin categorization.
+ */
+class Plugin_Categorization extends Base {
+ public function __construct() {
+ register_rest_route( 'plugins/v1', '/plugin/(?P<plugin_slug>[^/]+)/community/?', [
+ [
+ 'methods' => WP_REST_Server::CREATABLE,
+ 'callback' => [ $this, 'save_external_repository_url' ],
+ 'permission_callback' => function( $request ) {
+ return current_user_can(
+ 'plugin_admin_edit',
+ Plugin_Directory::get_plugin_post( $request['plugin_slug'] )
+ );
+ },
+ 'args' => [
+ 'plugin_slug' => [
+ 'validate_callback' => [ $this, 'validate_plugin_slug_callback' ],
+ 'required' => true,
+ ],
+ 'repositoryURL' => [
+ 'validate_callback' => [ $this, 'validate_url' ],
+ 'required' => true,
+ ],
+ ],
+ ],
+ ] );
+
+ register_rest_route( 'plugins/v1', '/plugin/(?P<plugin_slug>[^/]+)/commercial/?', [
+ [
+ 'methods' => WP_REST_Server::CREATABLE,
+ 'callback' => [ $this, 'save_external_support_url' ],
+ 'permission_callback' => function( $request ) {
+ return current_user_can(
+ 'plugin_admin_edit',
+ Plugin_Directory::get_plugin_post( $request['plugin_slug'] )
+ );
+ },
+ 'args' => [
+ 'plugin_slug' => [
+ 'validate_callback' => [ $this, 'validate_plugin_slug_callback' ],
+ 'required' => true,
+ ],
+ 'supportURL' => [
+ 'validate_callback' => [ $this, 'validate_url' ],
+ 'required' => true,
+ ],
+ ],
+ ],
+ ] );
+ }
+
+ /**
+ * Validates a URL.
+ *
+ * @param string $value Submitted field value.
+ * @return bool True if URL is valid, else false.
+ */
+ public function validate_url( $value ) {
+ $value = trim( strip_tags( stripslashes( $value ) ) );
+
+ if ( ! $value ) {
+ return true;
+ }
+
+ return (bool) filter_var( $value, FILTER_VALIDATE_URL );
+ }
+
+ /**
+ * Saves the submitted repository URL.
+ *
+ * @param WP_REST_Request $request Full details about the request.
+ * @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure.
+ */
+ public function save_external_repository_url( $request ) {
+ return $this->save_url( 'external_repository_url', 'repositoryURL', $request );
+ }
+
+ /**
+ * Saves the submitted support URL.
+ *
+ * @param WP_REST_Request $request Full details about the request.
+ * @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure.
+ */
+ public function save_external_support_url( $request ) {
+ return $this->save_url( 'external_support_url', 'supportURL', $request );
+ }
+
+ /**
+ * Saves a URL as post meta.
+ *
+ * @param WP_REST_Request $request Full details about the request.
+ * @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure.
+ */
+ protected function save_url( $meta_key, $request_key, $request ) {
+ $url = $request[ $request_key ] ?? '';
+ $post = Plugin_Directory::get_plugin_post( $request['plugin_slug'] );
+
+ if ( ! $post ) {
+ return;
+ }
+
+ $fail = false;
+
+ // Sanitize URL.
+ if ( $url ) {
+ $url = trim( strip_tags( stripslashes( $url ) ) );
+ }
+
+ // Delete post meta if new value is empty, else save.
+ if ( ! $url ) {
+ delete_post_meta( $post->ID, $meta_key );
+ } else {
+ update_post_meta( $post->ID, $meta_key, wp_slash( esc_url_raw( $url, [ 'http', 'https' ] ) ) );
+ }
+
+ if ( $fail ) {
+ return new WP_Error( 'failed', __( 'The operation failed. Please try again.', 'wporg-plugins' ) );
+ }
+
+ return [ $request_key => $url ];
+ }
+}
</ins><span class="cx" style="display: block; padding: 0 10px">Property changes on: sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/api/routes/class-plugin-categorization.php
</span><span class="cx" style="display: block; padding: 0 10px">___________________________________________________________________
</span></span></pre></div>
<a id="svneolstyle"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: svn:eol-style</h4></div>
<ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+native
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span><a id="sitestrunkwordpressorgpublic_htmlwpcontentpluginsplugindirectoryclassplugindirectoryphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/class-plugin-directory.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/plugin-directory/class-plugin-directory.php 2022-12-15 17:57:02 UTC (rev 12336)
+++ sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/class-plugin-directory.php 2022-12-15 18:08:03 UTC (rev 12337)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -601,6 +601,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> register_widget( __NAMESPACE__ . '\Widgets\Contributors' );
</span><span class="cx" style="display: block; padding: 0 10px"> register_widget( __NAMESPACE__ . '\Widgets\Support_Reps' );
</span><span class="cx" style="display: block; padding: 0 10px"> register_widget( __NAMESPACE__ . '\Widgets\Adopt_Me' );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ register_widget( __NAMESPACE__ . '\Widgets\Categorization' );
</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>
<a id="sitestrunkwordpressorgpublic_htmlwpcontentpluginsplugindirectorywidgetsclasscategorizationphp"></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/plugin-directory/widgets/class-categorization.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/plugin-directory/widgets/class-categorization.php (rev 0)
+++ sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/widgets/class-categorization.php 2022-12-15 18:08:03 UTC (rev 12337)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,74 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+namespace WordPressdotorg\Plugin_Directory\Widgets;
+
+use WordPressdotorg\Plugin_Directory\Plugin_I18n;
+use WordPressdotorg\Plugin_Directory\Template;
+
+/**
+ * A Widget to display categorization information about a plugin.
+ *
+ * @package WordPressdotorg\Plugin_Directory\Widgets
+ */
+class Categorization extends \WP_Widget {
+
+ /**
+ * Categorization constructor.
+ */
+ public function __construct() {
+ parent::__construct( 'plugin_categorization', __( 'Plugin Categorization', 'wporg-plugins' ), [
+ 'classname' => 'plugin-categorization',
+ 'description' => __( 'Displays plugin categorization information.', 'wporg-plugins' ),
+ ] );
+ }
+
+ /**
+ * Outputs the content of the widget.
+ *
+ * @param array $args
+ * @param array $instance
+ */
+ public function widget( $args, $instance ) {
+ $post = get_post();
+
+ if ( has_term( 'commercial', 'plugin_business_model', $post ) ) {
+ $model_type = 'commercial';
+ $title = __( 'Commercial Plugin', 'wporg-plugins' );
+ $url = get_post_meta( $post->ID, 'external_support_url', true );
+ $link_text = __( 'Support', 'wporg-plugins' );
+ $description = __( 'This plugin is free but offers additional paid commercial upgrades or support.', 'wporg-plugins' );
+ }
+ elseif ( has_term( 'community', 'plugin_business_model', $post ) ) {
+ $model_type = 'community';
+ $title = __( 'Community Plugin', 'wporg-plugins' );
+ $url = get_post_meta( $post->ID, 'external_repository_url', true );
+ $link_text = __( 'Contribute', 'wporg-plugins' );
+ $description = __( 'This plugin is developed and supported by a community.', 'wporg-plugins' );
+ }
+ else {
+ return;
+ }
+
+ echo $args['before_widget'];
+ ?>
+
+ <div class="widget categorization-widget categorization-widget-<?php echo esc_attr( $model_type ); ?>">
+ <div class="widget-head">
+ <h2><?php echo esc_html( apply_filters( 'widget_title', $title, $instance, $this->id_base ) ); ?></h2>
+
+ <?php
+ // Always show URL if there is one, but also output the markup if on the advanced view tab
+ // and the current user can update the categorization options so that the update can be
+ // easily reflected in the widget on the same page. (CSS will prevent a link with an empty
+ // URL from being shown.)
+ if ( $url || ( get_query_var( 'plugin_advanced' ) && current_user_can( 'plugin_admin_edit', $post ) ) ) {
+ printf( '<a href="%1$s" rel="nofollow">%2$s</a>', esc_url( $url ), esc_html( $link_text ) );
+ }
+ ?>
+ </div>
+
+ <p><?php echo esc_html( $description ); ?></p>
+ </div>
+ <?php
+ echo $args['after_widget'];
+ }
+}
</ins><span class="cx" style="display: block; padding: 0 10px">Property changes on: sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/widgets/class-categorization.php
</span><span class="cx" style="display: block; padding: 0 10px">___________________________________________________________________
</span></span></pre></div>
<a id="svneolstyle"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: svn:eol-style</h4></div>
<ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+native
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span></div>
</body>
</html>