<!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>[BuddyPress][9414] trunk: Use `bp_sanitize_pagination_arg()` in `BP_Notifications_Template` and include related tests.</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://buddypress.trac.wordpress.org/changeset/9414">9414</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"http://buddypress.trac.wordpress.org/changeset/9414","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>johnjamesjacoby</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2015-01-29 16:30:16 +0000 (Thu, 29 Jan 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'>Use `bp_sanitize_pagination_arg()` in `BP_Notifications_Template` and include related tests. This prevents pagination values from being overridden outside of anticipated boundaries. See <a href="http://buddypress.trac.wordpress.org/ticket/5796">#5796</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpnotificationsbpnotificationstemplatephp">trunk/src/bp-notifications/bp-notifications-template.php</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li><a href="#trunktestsphpunittestcasesnotificationstemplatephp">trunk/tests/phpunit/testcases/notifications/template.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpnotificationsbpnotificationstemplatephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-notifications/bp-notifications-template.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-notifications/bp-notifications-template.php 2015-01-29 16:24:36 UTC (rev 9413)
+++ trunk/src/bp-notifications/bp-notifications-template.php 2015-01-29 16:30:16 UTC (rev 9414)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -282,18 +282,6 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Overrides
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Set which pagination page
- if ( isset( $_GET[ $r['page_arg'] ] ) ) {
- $r['page'] = intval( $_GET[ $r['page_arg'] ] );
- }
-
- // Set the number to show per page
- if ( isset( $_GET['num'] ) ) {
- $r['per_page'] = intval( $_GET['num'] );
- } else {
- $r['per_page'] = intval( $r['per_page'] );
- }
-
</del><span class="cx" style="display: block; padding: 0 10px"> // Sort order direction
</span><span class="cx" style="display: block; padding: 0 10px"> $orders = array( 'ASC', 'DESC' );
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! empty( $_GET['sort_order'] ) && in_array( $_GET['sort_order'], $orders ) ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -303,12 +291,12 @@
</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"> // Setup variables
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->pag_page = $r['page'];
- $this->pag_num = $r['per_page'];
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->pag_arg = sanitize_key( $r['page_arg'] );
+ $this->pag_page = bp_sanitize_pagination_arg( $this->pag_arg, $r['page'] );
+ $this->pag_num = bp_sanitize_pagination_arg( 'num', $r['per_page'] );
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->user_id = $r['user_id'];
</span><span class="cx" style="display: block; padding: 0 10px"> $this->is_new = $r['is_new'];
</span><span class="cx" style="display: block; padding: 0 10px"> $this->search_terms = $r['search_terms'];
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->page_arg = $r['page_arg'];
</del><span class="cx" style="display: block; padding: 0 10px"> $this->order_by = $r['order_by'];
</span><span class="cx" style="display: block; padding: 0 10px"> $this->sort_order = $r['sort_order'];
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -338,7 +326,7 @@
</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"> $this->pag_links = paginate_links( array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'base' => add_query_arg( $this->page_arg, '%#%' ),
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'base' => add_query_arg( $this->pag_arg, '%#%' ),
</ins><span class="cx" style="display: block; padding: 0 10px"> 'format' => '',
</span><span class="cx" style="display: block; padding: 0 10px"> 'total' => ceil( (int) $this->total_notification_count / (int) $this->pag_num ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'current' => $this->pag_page,
</span></span></pre></div>
<a id="trunktestsphpunittestcasesnotificationstemplatephp"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/tests/phpunit/testcases/notifications/template.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/testcases/notifications/template.php (rev 0)
+++ trunk/tests/phpunit/testcases/notifications/template.php 2015-01-29 16:30:16 UTC (rev 9414)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,78 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+/**
+ * @group notifications
+ * @group template
+ */
+class BP_Tests_Notifications_Template extends BP_UnitTestCase {
+ public function setUp() {
+ parent::setUp();
+ }
+
+ public function tearDown() {
+ parent::tearDown();
+ }
+
+ /**
+ * @group BP_Notifications_Template
+ */
+ public function test_bp_notifications_template_should_give_precedence_to_npage_URL_param() {
+ $request = $_REQUEST;
+ $_REQUEST['npage'] = '5';
+
+ $at = new BP_Notifications_Template( array(
+ 'page' => 8,
+ ) );
+
+ $this->assertEquals( 5, $at->pag_page );
+
+ $_REQUEST = $request;
+ }
+
+ /**
+ * @group BP_Notifications_Template
+ */
+ public function test_bp_notifications_template_should_reset_0_pag_page_URL_param_to_default_pag_page_value() {
+ $request = $_REQUEST;
+ $_REQUEST['npage'] = '0';
+
+ $at = new BP_Notifications_Template( array(
+ 'page' => 8,
+ ) );
+
+ $this->assertEquals( 8, $at->pag_page );
+
+ $_REQUEST = $request;
+ }
+
+ /**
+ * @group BP_Notifications_Template
+ */
+ public function test_bp_notifications_template_should_give_precedence_to_num_URL_param() {
+ $request = $_REQUEST;
+ $_REQUEST['num'] = '14';
+
+ $at = new BP_Notifications_Template( array(
+ 'per_page' => 13,
+ ) );
+
+ $this->assertEquals( 14, $at->pag_num );
+
+ $_REQUEST = $request;
+ }
+
+ /**
+ * @group BP_Notifications_Template
+ */
+ public function test_bp_notifications_template_should_reset_0_pag_num_URL_param_to_default_pag_num_value() {
+ $request = $_REQUEST;
+ $_REQUEST['num'] = '0';
+
+ $at = new BP_Notifications_Template( array(
+ 'per_page' => 13,
+ ) );
+
+ $this->assertEquals( 13, $at->pag_num );
+
+ $_REQUEST = $request;
+ }
+}
</ins></span></pre>
</div>
</div>
</body>
</html>