<!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>[4361] sites/trunk/wordcamp.org/public_html/wp-content/plugins/camptix-badge-generator/includes/indesign-badges.php: CampTix Badge Generator: Add admin flags to CSV</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/4361">4361</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/4361","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>iandunn</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2016-11-15 19:51:13 +0000 (Tue, 15 Nov 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'>CampTix Badge Generator: Add admin flags to CSV</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#sitestrunkwordcamporgpublic_htmlwpcontentpluginscamptixbadgegeneratorincludesindesignbadgesphp">sites/trunk/wordcamp.org/public_html/wp-content/plugins/camptix-badge-generator/includes/indesign-badges.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="sitestrunkwordcamporgpublic_htmlwpcontentpluginscamptixbadgegeneratorincludesindesignbadgesphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: sites/trunk/wordcamp.org/public_html/wp-content/plugins/camptix-badge-generator/includes/indesign-badges.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- sites/trunk/wordcamp.org/public_html/wp-content/plugins/camptix-badge-generator/includes/indesign-badges.php 2016-11-15 19:51:09 UTC (rev 4360)
+++ sites/trunk/wordcamp.org/public_html/wp-content/plugins/camptix-badge-generator/includes/indesign-badges.php 2016-11-15 19:51:13 UTC (rev 4361)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -132,9 +132,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @todo Accept $destination_directory, $empty_twitter, and arbitrary tix_question fields from form input
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @todo Twitter username gets prefixed with ' by wcorg_esc_csv. Spreadsheet programs will ignore that, but
- * InDesign might not. If it doesn't, need to do something else to prevent the user having to manually remove
- * them.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @todo Twitter username and Gravatar get prefixed with ' by wcorg_esc_csv. Spreadsheet programs will ignore
+ * that, but InDesign might not. If it doesn't, need to do something else to prevent the user having to manually
+ * remove them. Maybe just don't escape because the user isn't going to manually review the data for anything
+ * malicious, so there's no point in relying on that.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $csv_filename
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $zip_local_folder
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -147,25 +148,17 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $csv_handle = fopen( $csv_filename, 'w' );
</span><span class="cx" style="display: block; padding: 0 10px"> $destination_directory = "Macintosh HD:Users:your_username:Desktop:$zip_local_folder:gravatars:";
</span><span class="cx" style="display: block; padding: 0 10px"> $empty_twitter = '';
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $admin_flags = get_admin_flags();
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $header_row = array(
- 'First Name', 'Last Name', 'Email Address', 'Ticket', 'Coupon', 'Twitter',
- '@Gravatar' // Prefixed with an @ to let InDesign know that it contains an image
- );
-
</del><span class="cx" style="display: block; padding: 0 10px"> if ( ! $csv_handle ) {
</span><span class="cx" style="display: block; padding: 0 10px"> Logger\log( 'open_csv_failed' );
</span><span class="cx" style="display: block; padding: 0 10px"> throw new \Exception( __( "Couldn't open CSV file.", 'wordcamporg' ) );
</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">- /*
- * Intentionally not escaping the header, because we need to preserve the `@` for InDesign. The values are all
- * hardcoded strings, so they're safe.
- */
- fputcsv( $csv_handle, $header_row );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ fputcsv( $csv_handle, wcorg_esc_csv( get_header_row( $admin_flags ) ) );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $attendees as $attendee ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $row = get_attendee_csv_row( $attendee, $gravatar_folder, $destination_directory, $empty_twitter );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $row = get_attendee_csv_row( $attendee, $gravatar_folder, $destination_directory, $empty_twitter, $admin_flags );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( empty( $row ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> continue;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -178,16 +171,51 @@
</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">+ * Get the admin flags
+ *
+ * @return array
+ */
+function get_admin_flags() {
+ /** @var \CampTix_Plugin $camptix */
+ global $camptix;
+
+ $flags = array();
+ $camptix_options = $camptix->get_options();
+
+ if ( ! empty( $camptix_options['camptix-admin-flags-data-parsed'] ) ) {
+ $flags = $camptix_options['camptix-admin-flags-data-parsed'];
+ }
+
+ return $flags;
+}
+
+/**
+ * Get the header row for the CSV
+ *
+ * @param array $admin_flags
+ *
+ * @return array
+ */
+function get_header_row( $admin_flags ) {
+ $header_row = array( 'First Name', 'Last Name', 'Email Address', 'Ticket', 'Coupon', 'Twitter', );
+ $header_row = array_merge( $header_row, array_values( $admin_flags ) );
+ $header_row[] = '@Gravatar'; // Prefixed with an @ to let InDesign know that it contains an image. Last because InDesign complains if it's not.
+
+ return $header_row;
+}
+
+/**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Get the CSV row for the given attendee
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param \WP_Post $attendee
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $gravatar_folder
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $destination_directory
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $empty_twitter
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array $admin_flags
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @return array
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-function get_attendee_csv_row( $attendee, $gravatar_folder, $destination_directory, $empty_twitter ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+function get_attendee_csv_row( $attendee, $gravatar_folder, $destination_directory, $empty_twitter, $admin_flags ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $row = array();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( 'unknown.attendee@example.org' == $attendee->tix_email ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -197,6 +225,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $gravatar_path = '';
</span><span class="cx" style="display: block; padding: 0 10px"> $first_name = ucwords( $attendee->tix_first_name );
</span><span class="cx" style="display: block; padding: 0 10px"> $gravatar_filename = get_gravatar_filename( $attendee );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $attendee_flags = (array) get_post_meta( $attendee->ID, 'camptix-admin-flag' );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( file_exists( $gravatar_folder .'/'. $gravatar_filename ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $gravatar_path = $destination_directory . $gravatar_filename;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -212,6 +241,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'gravatar-path' => $gravatar_path,
</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">+ foreach ( $admin_flags as $key => $label ) {
+ $row[ $key ] = in_array( $key, $attendee_flags, true ) ? 'yes' : 'no';
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> return $row;
</span><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>