How to change mailing form and set the default value for url_tracking to false?

Question

Is it possible to alter the mailing form? I want to set the default value for url_tracking to false. Usually I would write a hook_civicrm_buildForm and set a custom default value but this hook is not being called when loading the mailing form.

Answer 1

Disclaimer: I'm not an angularjs expert

Again this is a bit of a hack, we are intercepting a built-in CiviCRM angular directive and extending to add behaviour.

Create a custom extensions or use an existing one and implement hook_civicrm_angularModules:

function myextension_civicrm_angularModules(&$angularModules){
        $angularModules['myModule'] = array(
                'ext' => 'myextension',
                'js' => array('js/myModule.js'),
        );
}

In your js file:

// js/myModule.js

(function(angular, $, _){
  // Your module
  angular.module('myModule', []);

  // the hack
  angular.module('crmMailing').config(function($provide){

    // crmMailingBlockTracking directive
    $provide.decorator('crmMailingBlockTrackingDirective', function($delegate){
        var directive = $delegate[0];

        // Original link function
        var link = directive.link;

        // compile function, returns new link function
        directive.compile = function(){
            return function(scope, element, attrs){
                // get old link functionality
                link.apply(this, arguments);

                // new functionality here
                scope.$parent.$watch(attrs.crmMailing, function(){
                    var createdDate = new Date(scope.mailing.created_date).getTime()/1000;
                    var nowDate = new Date().getTime()/1000;

                    if((nowDate - createdDate) < 60){
                        scope.mailing.url_tracking = '0';
                        CRM.alert('Tracking Disabled');
                    }

                }); 
            };
        };

        return $delegate;
    });
  });
})(angular, CRM.$, CRM._);

The angular Mailing app uses a kind of boilerplate service, crmMailingSimpleDirective for constructing directives see here more info

The above snippet will do the same as my other answer without relying on setTimeout().

Hope that helps.

Answer 2

I guess this is not the best way to do it and perhaps someone can point you to a better solution. I'll put it as an answer for readability purposes.

Edit

Create a custom extensions or use an exiting and implement hook_civicrm_pageRun, something like:

function myextension_civicrm_pageRun(&$page){
  $pageName = $page->getVar('_name');
  if ($pageName == 'Civi\Angular\Page\Main') {
    CRM_Core_Resources::singleton()->addScriptFile('myextension', 'js/myJsScript.js');
  }
}

Edit: making some assumption this is with what I came up, as I said not the best thing to do but... perhaps someone finds it useful.

// js/myJsScript.js

CRM.$(function($){

  var disableUrlTracking = function(){
    // Access angular $scope
    var mailingElement = document.querySelector('[ng-model="mailing.url_tracking"]');
    var mailingScope = angular.element(mailingElement).scope();

    // Convert the mailing created date into seconds
    var createdDate = new Date(mailingScope.mailing.created_date).getTime()/1000;

    // Current date into seconds
    var nowDate = new Date().getTime()/1000;

    // Compare both dates
    var dif = nowDate - createdDate;

      // if the difference is less 60 seconds, assuming that to creat a mailing takes more than 60 seconds
    if(dif <= 60){
      mailingScope.mailing.url_tracking = '0';
      CRM.alert('URL Tracking disabled', 'URL Tracking');
    }
  }
  // Optional: wait for the page to load completeley, in my case it takes some seconds until it renders the whole mailing page.
  // If you don't have that issue just call the function
  setTimeout(disableUrlTracking, 4000 );

});

Answer 3

In Drupal you can do this with hook_civicrm_pre():

function mymodule_civicrm_pre($op, $objectName, $id, &$params) {
  if ($objectName == 'Mailing' && $op == 'create') {
    $params['url_tracking'] = 0;
  }
}

Answer 4

Another option you may want to consider is installing CiviProxy. You set it up somewhere on the public Internet (I imagine a free hosting account would suffice), whitelist its IP in your firewall, and it has a very limited ability to talk to CiviCRM. But the CiviProxy extension will rewrite your URL tracking to go to the proxy - and the proxy knows how to handle the rewrite. It also lets you, e.g. embed images in your mailing, which otherwise wouldn't be possible.

Answer 5

I wrote an extension borrowing heavily from @andrei, with a few improvements on identifying a creation vs modification of a draft

Hope you find it useful

https://github.com/TechToThePeople/privacier

Answer 6

This feature is now part of core: Administer -> CiviMail -> CiviMail Component Settings: