<!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>[42528] trunk/src/wp-admin/js/password-strength-meter.js: Docs: Improve JSDoc for `password-strength-meter.js`.</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="https://core.trac.wordpress.org/changeset/42528">42528</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/42528","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>atimmer</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2018-01-18 13:38:26 +0000 (Thu, 18 Jan 2018)</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'>Docs: Improve JSDoc for `password-strength-meter.js`.
Props herregroen, carolinegeven, ireneyoast, jjcomack.
Fixes <a href="https://core.trac.wordpress.org/ticket/43066">#43066</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminjspasswordstrengthmeterjs">trunk/src/wp-admin/js/password-strength-meter.js</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadminjspasswordstrengthmeterjs"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-admin/js/password-strength-meter.js</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/js/password-strength-meter.js 2018-01-18 05:17:23 UTC (rev 42527)
+++ trunk/src/wp-admin/js/password-strength-meter.js 2018-01-18 13:38:26 UTC (rev 42528)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3,13 +3,28 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> var passwordStrength;
</span><span class="cx" style="display: block; padding: 0 10px"> (function($){
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Contains functions to determine the password strength.
+ *
+ * @since 3.7.0
+ *
+ * @namespace
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> wp.passwordStrength = {
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Determine the strength of a given password
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Determines the strength of a given password.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string password1 The password
- * @param array blacklist An array of words that will lower the entropy of the password
- * @param string password2 The confirmed password
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Compares first password to the password confirmation.
+ *
+ * @since 3.7.0
+ *
+ * @param {string} password1 The subject password.
+ * @param {Array} blacklist An array of words that will lower the entropy of
+ * the password.
+ * @param {string} password2 The password confirmation.
+ *
+ * @returns {number} The password strength score.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> meter : function( password1, blacklist, password2 ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! $.isArray( blacklist ) )
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -28,9 +43,15 @@
</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"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Builds an array of data that should be penalized, because it would lower the entropy of a password if it were used
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Builds an array of words that should be penalized.
</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 array The array of data to be blacklisted
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Certain words need to be penalized because it would lower the entropy of a
+ * password if they were used. The blacklist is based on user input fields such
+ * as username, first name, email etc.
+ *
+ * @since 3.7.0
+ *
+ * @returns {string[]} The array of words to be blacklisted.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> userInputBlacklist : function() {
</span><span class="cx" style="display: block; padding: 0 10px"> var i, userInputFieldsLength, rawValuesLength, currentField,
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -38,7 +59,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> blacklist = [],
</span><span class="cx" style="display: block; padding: 0 10px"> userInputFields = [ 'user_login', 'first_name', 'last_name', 'nickname', 'display_name', 'email', 'url', 'description', 'weblog_title', 'admin_email' ];
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Collect all the strings we want to blacklist
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Collect all the strings we want to blacklist.
</ins><span class="cx" style="display: block; padding: 0 10px"> rawValues.push( document.title );
</span><span class="cx" style="display: block; padding: 0 10px"> rawValues.push( document.URL );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -54,7 +75,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> rawValues.push( currentField.val() );
</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">- // Strip out non-alphanumeric characters and convert each word to an individual entry
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /*
+ * Strip out non-alphanumeric characters and convert each word to an
+ * individual entry.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> rawValuesLength = rawValues.length;
</span><span class="cx" style="display: block; padding: 0 10px"> for ( i = 0; i < rawValuesLength; i++ ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( rawValues[ i ] ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -62,7 +86,10 @@
</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">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Remove empty values, short words, and duplicates. Short words are likely to cause many false positives.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /*
+ * Remove empty values, short words and duplicates. Short words are likely to
+ * cause many false positives.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> blacklist = $.grep( blacklist, function( value, key ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( '' === value || 4 > value.length ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return false;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -75,6 +102,17 @@
</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">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Back-compat.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Backward compatibility.
+
+ /**
+ * Password strength meter function.
+ *
+ * @since 2.5.0
+ * @deprecated 3.7.0 Use wp.passwordStrength.meter instead.
+ *
+ * @global
+ *
+ * @type {wp.passwordStrength.meter}
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> passwordStrength = wp.passwordStrength.meter;
</span><span class="cx" style="display: block; padding: 0 10px"> })(jQuery);
</span></span></pre>
</div>
</div>
</body>
</html>