<!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>[12712] sites/trunk/wordpress.org/public_html/wp-content/plugins/trac-notifications: Trac: Add a custom API to fetch/set user preferences.</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/12712">12712</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/12712","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>2023-07-05 05:04:40 +0000 (Wed, 05 Jul 2023)</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'>Trac: Add a custom API to fetch/set user preferences. Take Two.

See <a href="http://meta.trac.wordpress.org/changeset/12711">[12711]</a>.
See <a href="http://meta.trac.wordpress.org/ticket/5055">#5055</a>.</pre>

<h3>Modified Paths</h3>
<ul>
<li><a href="#sitestrunkwordpressorgpublic_htmlwpcontentpluginstracnotificationstracnotificationsdbphp">sites/trunk/wordpress.org/public_html/wp-content/plugins/trac-notifications/trac-notifications-db.php</a></li>
<li><a href="#sitestrunkwordpressorgpublic_htmlwpcontentpluginstracnotificationstracnotificationssqlitedriverphp">sites/trunk/wordpress.org/public_html/wp-content/plugins/trac-notifications/trac-notifications-sqlite-driver.php</a></li>
</ul>

</div>
<div id="patch">
<h3>Diff</h3>
<a id="sitestrunkwordpressorgpublic_htmlwpcontentpluginstracnotificationstracnotificationsdbphp"></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/trac-notifications/trac-notifications-db.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/trac-notifications/trac-notifications-db.php     2023-07-05 04:06:16 UTC (rev 12711)
+++ sites/trunk/wordpress.org/public_html/wp-content/plugins/trac-notifications/trac-notifications-db.php       2023-07-05 05:04:40 UTC (rev 12712)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -213,55 +213,49 @@
</span><span class="cx" style="display: block; padding: 0 10px">         *
</span><span class="cx" style="display: block; padding: 0 10px">         * @param string $username   The username.
</span><span class="cx" style="display: block; padding: 0 10px">         * @param string $name       The preference.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-         * @param string|null $value The value to set. If null, the preference will be deleted.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+  * @param string|null $value The value to set.
</ins><span class="cx" style="display: block; padding: 0 10px">          */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-        function set_user_pref( $username, $name, $value = null ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ function set_user_pref( $username, $name, $value = '' ) {
</ins><span class="cx" style="display: block; padding: 0 10px">                 // The trac column for username is `sid`. All our users are authenticated.
</span><span class="cx" style="display: block; padding: 0 10px">                // The session_attribute table has an index: UNIQUE (sid,authenticated,name)
</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 ( ! is_null( $value ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+         $result = $this->db->insert( 'session_attribute', array(
+                       'sid'           => $username,
+                       'authenticated' => 1,
+                       'name'          => $name,
+                       'value'         => $value
+               ) );
+
+               if ( ! $result ) {
</ins><span class="cx" style="display: block; padding: 0 10px">                         $result = $this->db->update(
</span><span class="cx" style="display: block; padding: 0 10px">                                'session_attribute',
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-                                [ 'value' => $value ],
-                               [
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+                         array(
+                                       'value'         => $value
+                               ), array(
</ins><span class="cx" style="display: block; padding: 0 10px">                                         'sid'           => $username,
</span><span class="cx" style="display: block; padding: 0 10px">                                        'authenticated' => 1,
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-                                        'name'          => $name
-                               ]
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+                                 'name'          => $name,
+                               )
</ins><span class="cx" style="display: block; padding: 0 10px">                         );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+                }
</ins><span class="cx" style="display: block; padding: 0 10px"> 
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-                        if ( ! $result ) {
-                               // Insert the session if it doesn't exist.
-                               $user_has_visited_trac = $this->db->get_var( $this->db->prepare(
-                                       'SELECT sid FROM session WHERE sid = %s',
-                                       $username
-                               ) );
-                               if ( ! $user_has_visited_trac ) {
-                                       $this->db->insert( 'session', [
-                                               'sid'           => $username,
-                                               'authenticated' => 1,
-                                               'last_visit'    => time(),
-                                       ] );
-                               }
-
-                               // Set the pref.
-                               $result = $this->db->insert( 'session_attribute', [
-                                       'sid'           => $username,
-                                       'authenticated' => 1,
-                                       'name'          => $name,
-                                       'value'         => $value,
-                               ] );
-                       }
-
-                       return $result;
-               } else {
-                       return $this->db->delete( 'session_attribute', [
-                               'sid'           => $username,
-                               'authenticated' => 1,
-                               'name'          => $name
-                       ] );
-               }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+         return $result;
</ins><span class="cx" style="display: block; padding: 0 10px">         }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+        
+       /**
+        * Delete a user preference.
+        *
+        * @param string $username The username.
+        * @param string $name     The preference.
+        * @return bool
+        */
+       function delete_user_pref( $username, $name ) {
+               return $this->db->delete( 'session_attribute', array(
+                       'sid'           => $username,
+                       'authenticated' => 1,
+                       'name'          => $name
+               ) );
+       }
</ins><span class="cx" style="display: block; padding: 0 10px"> 
</span><span class="cx" style="display: block; padding: 0 10px">        function get_user_anonymization_items( $username ) {
</span><span class="cx" style="display: block; padding: 0 10px">                $ticket_subscriptions = $this->get_trac_ticket_subscriptions_for_user( $username );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -302,7 +296,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">                        'ticket_owner',
</span><span class="cx" style="display: block; padding: 0 10px">                        'attachments',
</span><span class="cx" style="display: block; padding: 0 10px">                        'comments',
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-                        'profile_data',
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+                 'profile_data'
</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_htmlwpcontentpluginstracnotificationstracnotificationssqlitedriverphp"></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/trac-notifications/trac-notifications-sqlite-driver.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/trac-notifications/trac-notifications-sqlite-driver.php  2023-07-05 04:06:16 UTC (rev 12711)
+++ sites/trunk/wordpress.org/public_html/wp-content/plugins/trac-notifications/trac-notifications-sqlite-driver.php    2023-07-05 05:04:40 UTC (rev 12712)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -50,6 +50,11 @@
</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><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+        /**
+        * Delete row(s) from a table.
+        *
+        * @return bool If the query ran.
+        */
</ins><span class="cx" style="display: block; padding: 0 10px">         public function delete( $table, $where ) {
</span><span class="cx" style="display: block; padding: 0 10px">                $fields = 'AND ' . implode( ' = %s AND ', array_keys( $where ) ) . ' = %s';
</span><span class="cx" style="display: block; padding: 0 10px">                $query = $this->prepare(
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -56,9 +61,14 @@
</span><span class="cx" style="display: block; padding: 0 10px">                        "DELETE FROM $table WHERE 1=1 $fields",
</span><span class="cx" style="display: block; padding: 0 10px">                        array_values( $where )
</span><span class="cx" style="display: block; padding: 0 10px">                );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-                $this->db->query( $query );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+         return (bool) $this->db->query( $query );
</ins><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">+        /**
+        * Insert a row into a table.
+        *
+        * @return bool If the query ran.
+        */
</ins><span class="cx" style="display: block; padding: 0 10px">         public function insert( $table, $args ) {
</span><span class="cx" style="display: block; padding: 0 10px">                $fields = "'" . implode( "', '", array_keys( $args ) ) . "'";
</span><span class="cx" style="display: block; padding: 0 10px">                $placeholders = implode( ', ', array_fill( 0, count( $args ), '%s' ) );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -69,10 +79,15 @@
</span><span class="cx" style="display: block; padding: 0 10px">                return (bool) $this->db->query( $query );
</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">+        /**
+        * Update a row in a table.
+        *
+        * @return bool If the query executed and modified rows.
+        */
</ins><span class="cx" style="display: block; padding: 0 10px">         public function update( $table, $data, $wheres ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-                $values     = [];
-               $sql_sets   = [];
-               $sql_wheres = [];
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+         $values     = array();
+               $sql_sets   = array();
+               $sql_wheres = array();
</ins><span class="cx" style="display: block; padding: 0 10px"> 
</span><span class="cx" style="display: block; padding: 0 10px">                foreach ( $data as $field => $value ) {
</span><span class="cx" style="display: block; padding: 0 10px">                        $sql_sets[] = "$field = %s";
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -80,13 +95,13 @@
</span><span class="cx" style="display: block; padding: 0 10px">                }
</span><span class="cx" style="display: block; padding: 0 10px">                $sql_sets = implode( ', ', $sql_sets );
</span><span class="cx" style="display: block; padding: 0 10px"> 
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-                foreach ( $wheres as $field => $where ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+         foreach ( $wheres as $field => $value ) {
</ins><span class="cx" style="display: block; padding: 0 10px">                         $sql_wheres[] = "$field = %s";
</span><span class="cx" style="display: block; padding: 0 10px">                        $values[]     = $value;
</span><span class="cx" style="display: block; padding: 0 10px">                }
</span><span class="cx" style="display: block; padding: 0 10px">                $sql_wheres = implode( ' AND ', $sql_wheres );
</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 ( ! $values ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+         if ( ! $values || ! $sql_wheres ) {
</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="lines" style="display: block; padding: 0 10px; color: #888">@@ -95,6 +110,8 @@
</span><span class="cx" style="display: block; padding: 0 10px">                        $values
</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">-                return (bool) $this->db->query( $query );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+         $result = $this->db->query( $query );
+
+               return $result && $result->rowCount() > 0;
</ins><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>