From 5ca340caf3c0c03e0fb63ed3143487d01cd683a4 Mon Sep 17 00:00:00 2001
From: Tim Otten <totten@civicrm.org>
Date: Tue, 12 May 2020 23:05:38 -0700
Subject: [PATCH] Implement 'extern/open.php' as a regular route

---
 CRM/Mailing/Page/Open.php        | 58 ++++++++++++++++++++++++++++++++
 CRM/Mailing/xml/Menu/Mailing.xml |  5 +++
 2 files changed, 63 insertions(+)
 create mode 100644 CRM/Mailing/Page/Open.php

diff --git a/CRM/Mailing/Page/Open.php b/CRM/Mailing/Page/Open.php
new file mode 100644
index 0000000000..ac26fbfff8
--- /dev/null
+++ b/CRM/Mailing/Page/Open.php
@@ -0,0 +1,58 @@
+<?php
+/*
+ +--------------------------------------------------------------------+
+ | Copyright CiviCRM LLC. All rights reserved.                        |
+ |                                                                    |
+ | This work is published under the GNU AGPLv3 license with some      |
+ | permitted exceptions and without any warranty. For full license    |
+ | and copyright information, see https://civicrm.org/licensing       |
+ +--------------------------------------------------------------------+
+ */
+
+/**
+ *
+ * @package CRM
+ * @copyright CiviCRM LLC https://civicrm.org/licensing
+ */
+
+/**
+ * Indicate that a CiviMail message has been opened
+ *
+ * General Usage: civicrm/mailing/open?qid={event_queue_id}
+ *
+ * NOTE: The parameter name has changed slightly from 'extern/open.php?q={event_queue_id}`.
+ */
+class CRM_Mailing_Page_Open extends CRM_Core_Page {
+
+  /**
+   * Mark the mailing as opened
+   *
+   * @throws \CRM_Core_Exception
+   */
+  public function run() {
+    $queue_id = CRM_Utils_Request::retrieveValue('qid', 'Positive', NULL, FALSE, 'GET');
+    if (!$queue_id) {
+      // Deprecated: "?q=" is problematic in Drupal integrations, but we'll accept if igiven
+      $queue_id = CRM_Utils_Request::retrieveValue('q', 'Positive', NULL, FALSE, 'GET');;
+    }
+    if (!$queue_id) {
+      echo "Missing input parameters\n";
+      exit();
+    }
+
+    CRM_Mailing_Event_BAO_Opened::open($queue_id);
+
+    $filename = Civi::paths()->getPath('[civicrm.root]/i/tracker.gif');
+
+    header('Cache-Control: must-revalidate, post-check=0, pre-check=0');
+    header('Content-Description: File Transfer');
+    header('Content-type: image/gif');
+    header('Content-Length: ' . filesize($filename));
+    header('Content-Disposition: inline; filename=tracker.gif');
+
+    readfile($filename);
+
+    CRM_Utils_System::civiExit();
+  }
+
+}
diff --git a/CRM/Mailing/xml/Menu/Mailing.xml b/CRM/Mailing/xml/Menu/Mailing.xml
index 7fea1938a4..d4cc7d274a 100644
--- a/CRM/Mailing/xml/Menu/Mailing.xml
+++ b/CRM/Mailing/xml/Menu/Mailing.xml
@@ -207,4 +207,9 @@
     <page_callback>CRM_Mailing_Page_Url</page_callback>
     <access_arguments>*always allow*</access_arguments>
   </item>
+  <item>
+    <path>civicrm/mailing/open</path>
+    <page_callback>CRM_Mailing_Page_Open</page_callback>
+    <access_arguments>*always allow*</access_arguments>
+  </item>
 </menu>
-- 
2.25.1