may/1KA_F2F
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add FB pixel

Browse Source
This commit is contained in:
Robert 2021-01-08 11:17:51 +01:00
parent 47f470167e
commit 3dcf246bda
15 changed files with 1181 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
frontend/drupal/modules/official_facebook_pixel/CODE_OF_CONDUCT.md Normal file
View File

@ -0,0 +1,5 @@
# Code of Conduct
Facebook has adopted a Code of Conduct that we expect project participants to adhere to.
Please read the [full text](https://code.fb.com/codeofconduct/)
so that you can understand what actions will and will not be tolerated.

35
frontend/drupal/modules/official_facebook_pixel/CONTRIBUTING.md Normal file
View File

@ -0,0 +1,35 @@
# Contributing to Official Facebook Pixel
We want to make contributing to this project as easy and transparent as
possible.
## Pull Requests
We actively welcome your pull requests.
1. Fork the repo and create your branch from `master`.
2. If you've added code that should be tested, add tests.
3. If you've changed APIs, update the documentation.
4. Make sure your code lints.
5. If you haven't already, complete the Contributor License Agreement ("CLA").
## Contributor License Agreement ("CLA")
In order to accept your pull request, we need you to submit a CLA. You only need
to do this once to work on any of Facebook's open source projects.
Complete your CLA here: <https://code.facebook.com/cla>
## Issues
We use GitHub issues to track public bugs. Please ensure your description is
clear and has sufficient instructions to be able to reproduce the issue.
Facebook has a [bounty program](https://www.facebook.com/whitehat/) for the safe
disclosure of security bugs. In those cases, please go through the process
outlined on that page and do not file a public issue.
## Coding Style
* 4 spaces for indentation rather than tabs
* 80 character line length
## License
By contributing to Official Facebook Pixel, you agree that your contributions
will be licensed under the LICENSE file in the root directory of
this source tree.

339
frontend/drupal/modules/official_facebook_pixel/LICENSE Normal file
View File

@ -0,0 +1,339 @@
GNU GENERAL PUBLIC LICENSE
Version 2, June 1991
Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The licenses for most software are designed to take away your
freedom to share and change it. By contrast, the GNU General Public
License is intended to guarantee your freedom to share and change free
software--to make sure the software is free for all its users. This
General Public License applies to most of the Free Software
Foundation's software and to any other program whose authors commit to
using it. (Some other Free Software Foundation software is covered by
the GNU Lesser General Public License instead.) You can apply it to
your programs, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
this service if you wish), that you receive source code or can get it
if you want it, that you can change the software or use pieces of it
in new free programs; and that you know you can do these things.
To protect your rights, we need to make restrictions that forbid
anyone to deny you these rights or to ask you to surrender the rights.
These restrictions translate to certain responsibilities for you if you
distribute copies of the software, or if you modify it.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must give the recipients all the rights that
you have. You must make sure that they, too, receive or can get the
source code. And you must show them these terms so they know their
rights.
We protect your rights with two steps: (1) copyright the software, and
(2) offer you this license which gives you legal permission to copy,
distribute and/or modify the software.
Also, for each author's protection and ours, we want to make certain
that everyone understands that there is no warranty for this free
software. If the software is modified by someone else and passed on, we
want its recipients to know that what they have is not the original, so
that any problems introduced by others will not reflect on the original
authors' reputations.
Finally, any free program is threatened constantly by software
patents. We wish to avoid the danger that redistributors of a free
program will individually obtain patent licenses, in effect making the
program proprietary. To prevent this, we have made it clear that any
patent must be licensed for everyone's free use or not licensed at all.
The precise terms and conditions for copying, distribution and
modification follow.
GNU GENERAL PUBLIC LICENSE
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
0. This License applies to any program or other work which contains
a notice placed by the copyright holder saying it may be distributed
under the terms of this General Public License. The "Program", below,
refers to any such program or work, and a "work based on the Program"
means either the Program or any derivative work under copyright law:
that is to say, a work containing the Program or a portion of it,
either verbatim or with modifications and/or translated into another
language. (Hereinafter, translation is included without limitation in
the term "modification".) Each licensee is addressed as "you".
Activities other than copying, distribution and modification are not
covered by this License; they are outside its scope. The act of
running the Program is not restricted, and the output from the Program
is covered only if its contents constitute a work based on the
Program (independent of having been made by running the Program).
Whether that is true depends on what the Program does.
1. You may copy and distribute verbatim copies of the Program's
source code as you receive it, in any medium, provided that you
conspicuously and appropriately publish on each copy an appropriate
copyright notice and disclaimer of warranty; keep intact all the
notices that refer to this License and to the absence of any warranty;
and give any other recipients of the Program a copy of this License
along with the Program.
You may charge a fee for the physical act of transferring a copy, and
you may at your option offer warranty protection in exchange for a fee.
2. You may modify your copy or copies of the Program or any portion
of it, thus forming a work based on the Program, and copy and
distribute such modifications or work under the terms of Section 1
above, provided that you also meet all of these conditions:
a) You must cause the modified files to carry prominent notices
stating that you changed the files and the date of any change.
b) You must cause any work that you distribute or publish, that in
whole or in part contains or is derived from the Program or any
part thereof, to be licensed as a whole at no charge to all third
parties under the terms of this License.
c) If the modified program normally reads commands interactively
when run, you must cause it, when started running for such
interactive use in the most ordinary way, to print or display an
announcement including an appropriate copyright notice and a
notice that there is no warranty (or else, saying that you provide
a warranty) and that users may redistribute the program under
these conditions, and telling the user how to view a copy of this
License. (Exception: if the Program itself is interactive but
does not normally print such an announcement, your work based on
the Program is not required to print an announcement.)
These requirements apply to the modified work as a whole. If
identifiable sections of that work are not derived from the Program,
and can be reasonably considered independent and separate works in
themselves, then this License, and its terms, do not apply to those
sections when you distribute them as separate works. But when you
distribute the same sections as part of a whole which is a work based
on the Program, the distribution of the whole must be on the terms of
this License, whose permissions for other licensees extend to the
entire whole, and thus to each and every part regardless of who wrote it.
Thus, it is not the intent of this section to claim rights or contest
your rights to work written entirely by you; rather, the intent is to
exercise the right to control the distribution of derivative or
collective works based on the Program.
In addition, mere aggregation of another work not based on the Program
with the Program (or with a work based on the Program) on a volume of
a storage or distribution medium does not bring the other work under
the scope of this License.
3. You may copy and distribute the Program (or a work based on it,
under Section 2) in object code or executable form under the terms of
Sections 1 and 2 above provided that you also do one of the following:
a) Accompany it with the complete corresponding machine-readable
source code, which must be distributed under the terms of Sections
1 and 2 above on a medium customarily used for software interchange; or,
b) Accompany it with a written offer, valid for at least three
years, to give any third party, for a charge no more than your
cost of physically performing source distribution, a complete
machine-readable copy of the corresponding source code, to be
distributed under the terms of Sections 1 and 2 above on a medium
customarily used for software interchange; or,
c) Accompany it with the information you received as to the offer
to distribute corresponding source code. (This alternative is
allowed only for noncommercial distribution and only if you
received the program in object code or executable form with such
an offer, in accord with Subsection b above.)
The source code for a work means the preferred form of the work for
making modifications to it. For an executable work, complete source
code means all the source code for all modules it contains, plus any
associated interface definition files, plus the scripts used to
control compilation and installation of the executable. However, as a
special exception, the source code distributed need not include
anything that is normally distributed (in either source or binary
form) with the major components (compiler, kernel, and so on) of the
operating system on which the executable runs, unless that component
itself accompanies the executable.
If distribution of executable or object code is made by offering
access to copy from a designated place, then offering equivalent
access to copy the source code from the same place counts as
distribution of the source code, even though third parties are not
compelled to copy the source along with the object code.
4. You may not copy, modify, sublicense, or distribute the Program
except as expressly provided under this License. Any attempt
otherwise to copy, modify, sublicense or distribute the Program is
void, and will automatically terminate your rights under this License.
However, parties who have received copies, or rights, from you under
this License will not have their licenses terminated so long as such
parties remain in full compliance.
5. You are not required to accept this License, since you have not
signed it. However, nothing else grants you permission to modify or
distribute the Program or its derivative works. These actions are
prohibited by law if you do not accept this License. Therefore, by
modifying or distributing the Program (or any work based on the
Program), you indicate your acceptance of this License to do so, and
all its terms and conditions for copying, distributing or modifying
the Program or works based on it.
6. Each time you redistribute the Program (or any work based on the
Program), the recipient automatically receives a license from the
original licensor to copy, distribute or modify the Program subject to
these terms and conditions. You may not impose any further
restrictions on the recipients' exercise of the rights granted herein.
You are not responsible for enforcing compliance by third parties to
this License.
7. If, as a consequence of a court judgment or allegation of patent
infringement or for any other reason (not limited to patent issues),
conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot
distribute so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you
may not distribute the Program at all. For example, if a patent
license would not permit royalty-free redistribution of the Program by
all those who receive copies directly or indirectly through you, then
the only way you could satisfy both it and this License would be to
refrain entirely from distribution of the Program.
If any portion of this section is held invalid or unenforceable under
any particular circumstance, the balance of the section is intended to
apply and the section as a whole is intended to apply in other
circumstances.
It is not the purpose of this section to induce you to infringe any
patents or other property right claims or to contest validity of any
such claims; this section has the sole purpose of protecting the
integrity of the free software distribution system, which is
implemented by public license practices. Many people have made
generous contributions to the wide range of software distributed
through that system in reliance on consistent application of that
system; it is up to the author/donor to decide if he or she is willing
to distribute software through any other system and a licensee cannot
impose that choice.
This section is intended to make thoroughly clear what is believed to
be a consequence of the rest of this License.
8. If the distribution and/or use of the Program is restricted in
certain countries either by patents or by copyrighted interfaces, the
original copyright holder who places the Program under this License
may add an explicit geographical distribution limitation excluding
those countries, so that distribution is permitted only in or among
countries not thus excluded. In such case, this License incorporates
the limitation as if written in the body of this License.
9. The Free Software Foundation may publish revised and/or new versions
of the General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the Program
specifies a version number of this License which applies to it and "any
later version", you have the option of following the terms and conditions
either of that version or of any later version published by the Free
Software Foundation. If the Program does not specify a version number of
this License, you may choose any version ever published by the Free Software
Foundation.
10. If you wish to incorporate parts of the Program into other free
programs whose distribution conditions are different, write to the author
to ask for permission. For software which is copyrighted by the Free
Software Foundation, write to the Free Software Foundation; we sometimes
make exceptions for this. Our decision will be guided by the two goals
of preserving the free status of all derivatives of our free software and
of promoting the sharing and reuse of software generally.
NO WARRANTY
11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
REPAIR OR CORRECTION.
12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
POSSIBILITY OF SUCH DAMAGES.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
convey the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
Also add information on how to contact you by electronic and paper mail.
If the program is interactive, make it output a short notice like this
when it starts in an interactive mode:
Gnomovision version 69, Copyright (C) year name of author
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, the commands you use may
be called something other than `show w' and `show c'; they could even be
mouse-clicks or menu items--whatever suits your program.
You should also get your employer (if you work as a programmer) or your
school, if any, to sign a "copyright disclaimer" for the program, if
necessary. Here is a sample; alter the names:
Yoyodyne, Inc., hereby disclaims all copyright interest in the program
`Gnomovision' (which makes passes at compilers) written by James Hacker.
<signature of Ty Coon>, 1 April 1989
Ty Coon, President of Vice
This General Public License does not permit incorporating your program into
proprietary programs. If your program is a subroutine library, you may
consider it more useful to permit linking proprietary applications with the
library. If this is what you want to do, use the GNU Lesser General
Public License instead of this License.

19
frontend/drupal/modules/official_facebook_pixel/README.md Normal file
View File

@ -0,0 +1,19 @@
# Official Facebook Pixel
Grow your business with Official Facebook Pixel! This plugin will
install a Facebook Pixel on your Drupal site, detect and fire pixel events automatically!
## Get started
Download the zip file marked 'official-facebook-pixel-7.x-[version number].zip' attached to the current release.
## Requirements
Official Facebook Pixel requires
* Drupal 7.x
* PHP 5.6 or greater
## License
Official Facebook Pixel is GPLv2-licensed.

53
frontend/drupal/modules/official_facebook_pixel/README.txt Normal file
View File

@ -0,0 +1,53 @@
CONTENTS OF THIS FILE
---------------------
* Introduction
* Requirements
* Installation
* FAQ
* Maintainers
INTRODUCTION
------------
This plugin will install a Facebook Pixel on your Drupal page. The Official Facebook Pixel allows
you to fire PageView events when people visit your website. Tracking pixel events can help you
understand the actions people are taking on your website. You can then use this information to
make adjustments accordingly in your advertising campaigns.
REQUIREMENTS
------------
* Drupal 7.x
* PHP 5.6 or greater
INSTALLATION
------------
1. Download the zip file attached to the current release.
2. Go to your Drupal 7.x site, sign in and enter the "Modules" tab.
3. Click "+ Install new module" and choose the zip file.
4. Enable the "Official Facebook Pixel" module by check the checkbox and click "Save configuration".
5. Go to the "Configuration" tab and click the "Official Facebook Pixel Settings".
6. Paste your Facebook pixel ID into the text input box and click "Save configuration".
FAQ
---
Q: Where can I find more information about Facebook Pixel?
A: https://www.facebook.com/business/learn/facebook-ads-pixel
Q: Where can I find more information about Official Facebook Pixel module?
A: https://www.facebook.com/business/help/1946768672286771
Q: I am a developer. Can I help improve the module?
A: Of course! This module is an open source project on GitHub. You can find the code and contribution instructions in: https://github.com/facebookincubator/Facebook-Pixel-for-Drupal.
MAINTAINERS
-----------
Current maintainers:
* Facebook Inc. - https://www.drupal.org/u/facebook

49
frontend/drupal/modules/official_facebook_pixel/official_facebook_pixel.admin.inc Normal file
View File

@ -0,0 +1,49 @@
<?php
/*
* Copyright (C) 2017-present, Facebook, Inc.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; version 2 of the License.
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*/
/**
* @file
* Contains facebook_pixel_settings_form.
*/
use Drupal\official_facebook_pixel\OfficialFacebookPixelConfig;
use Drupal\official_facebook_pixel\OfficialFacebookPixelOptions;
/**
* Implements hook_admin_settings().
*/
function official_facebook_pixel_settings_form($form, &$form_state) {
$options = OfficialFacebookPixelOptions::getInstance();
$form = array();
$form[OfficialFacebookPixelConfig::FORM_PIXEL_KEY] = array(
'#type' => 'textfield',
'#title' => t(OfficialFacebookPixelConfig::FORM_PIXEL_TITLE),
'#description' => t(OfficialFacebookPixelConfig::FORM_PIXEL_DESCRIPTION),
'#required' => TRUE,
'#default_value' => $options->getPixelId(),
);
$form[OfficialFacebookPixelConfig::FORM_PII_KEY] = array(
'#type' => 'checkbox',
'#title' => t(OfficialFacebookPixelConfig::FORM_PII_TITLE),
'#description' => t(sprintf(
OfficialFacebookPixelConfig::FORM_PII_DESCRIPTION,
OfficialFacebookPixelConfig::FORM_PII_DESCRIPTION_LINK)),
'#default_value' => $options->getUsePii(),
);
return system_settings_form($form);
}

15
frontend/drupal/modules/official_facebook_pixel/official_facebook_pixel.info Normal file
View File

@ -0,0 +1,15 @@
name = Official Facebook Pixel
description = Official plugin provided by Facebook that will install a Facebook Pixel on your Drupal site.
package = Statistics
core = 7.x
dependencies[] = xautoload
configure = admin/config/system/official_facebook_pixel
; Information added by Drupal.org packaging script on 2018-12-07
version = "7.x-1.1"
core = "7.x"
project = "officialfacebookpixel"
datestamp = "1544223783"

82
frontend/drupal/modules/official_facebook_pixel/official_facebook_pixel.module Normal file
View File

@ -0,0 +1,82 @@
<?php
/*
* Copyright (C) 2017-present, Facebook, Inc.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; version 2 of the License.
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*/
/**
* @file
* Contains facebook_pixel.module.
*/
use Drupal\official_facebook_pixel\OfficialFacebookPixelInjection;
use Drupal\official_facebook_pixel\OfficialFacebookPixelOptions;
use Drupal\official_facebook_pixel\OfficialFacebookPixelUtils;
use Drupal\official_facebook_pixel\PixelScriptBuilder;
/**
* Implements hook_permission().
*/
function official_facebook_pixel_permission() {
return array(
'admin' => array(
'title' => t('Official Facebook Pixel Plugin Admin'),
'description' => t('Official Facebook Pixel plugin admin.'),
),
);
}
/**
* Implements hook_menu().
*/
function official_facebook_pixel_menu() {
$items = array();
$items['admin/config/system/official_facebook_pixel'] = array(
'title' => t('Official Facebook Pixel Settings'),
'description' => t('Configure Official Facebook Pixel.'),
'page callback' => 'drupal_get_form',
'page arguments' => array('official_facebook_pixel_settings_form'),
'access arguments' => array('admin'),
'type' => MENU_NORMAL_ITEM,
'file' => 'official_facebook_pixel.admin.inc',
);
return $items;
}
/**
* Implements hook_page_build().
*/
function official_facebook_pixel_page_build(&$page) {
if (!should_render()) {
return;
}
$options = OfficialFacebookPixelOptions::getInstance();
// Return if pixel_id is not positive integer
if (!OfficialFacebookPixelUtils::isPositiveInteger($options->getPixelId())) {
return;
}
OfficialFacebookPixelInjection::injectPixelCode();
}
/**
* Check if pixel code should be rendered
*
* @return boolean True is should render pixel code, otherwise false.
*/
function should_render() {
global $user;
$roles = $user->roles;
return !(is_array($roles) && in_array("administrator", $roles));
}

52
frontend/drupal/modules/official_facebook_pixel/src/OfficialFacebookPixelConfig.php Normal file
View File

@ -0,0 +1,52 @@
<?php
/*
* Copyright (C) 2017-present, Facebook, Inc.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; version 2 of the License.
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*/
/**
* @file
* Contains \Drupal\official_facebook_pixel
* \OfficialFacebookPixelConfig.
*/
namespace Drupal\official_facebook_pixel;
/**
* Class OfficialFacebookPixelConfig.
*
* @package Drupal\official_facebook_pixel
*/
class OfficialFacebookPixelConfig {
const CONFIG_NAME = 'official_facebook_pixel.settings';
const FORM_ID = 'official_facebook_pixel_settings';
const FORM_PII_KEY = 'pii_id';
const FORM_PII_TITLE = 'Use Advanced Matching on pixel?';
const FORM_PII_DESCRIPTION = 'Enabling Advanced Matching improves audience building.<br />For businesses that operate in the European Union, you may need to take additional action. Read the <a href="%s" target="_blank">Cookie Consent Guide for Sites and Apps</a> for suggestions on complying with EU privacy requirements. the Facebook Pixel ID';
const FORM_PII_DESCRIPTION_LINK = 'https://developers.facebook.com/docs/privacy/';
const FORM_PIXEL_KEY = 'pixel_id';
const FORM_PIXEL_TITLE = 'Pixel ID';
const FORM_PIXEL_DESCRIPTION = 'Enter the Facebook Pixel ID';
const SOURCE_7 = 'pldrupal-7';
const SOURCE_8 = 'pldrupal-8';
// integration config for Drupal7: INTEGRATION_KEY => PLUGIN_CLASS
public static function integrationConfigFor7() {
return array(
);
}
// integration config for Drupal8: INTEGRATION_KEY => PLUGIN_CLASS
public static function integrationConfigFor8() {
return array(
);
}
}

72
frontend/drupal/modules/official_facebook_pixel/src/OfficialFacebookPixelInjection.php Normal file
View File

@ -0,0 +1,72 @@
<?php
/*
* Copyright (C) 2017-present, Facebook, Inc.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; version 2 of the License.
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*/
/**
* @file
* Contains \Drupal\official_facebook_pixel
* \OfficialFacebookPixelInjection.
*/
namespace Drupal\official_facebook_pixel;
use Drupal\official_facebook_pixel\OfficialFacebookPixelConfig;
use Drupal\official_facebook_pixel\OfficialFacebookPixelOptions;
/**
* Class OfficialFacebookPixelInjection.
*
* @package Drupal\official_facebook_pixel
*/
class OfficialFacebookPixelInjection {
public static function injectPixelCode() {
$options = OfficialFacebookPixelOptions::getInstance();
PixelScriptBuilder::initialize($options->getPixelId());
self::injectScriptCode($options);
self::injectNoScriptCode();
foreach (OfficialFacebookPixelConfig::integrationConfigFor7() as $key => $value) {
$class_name = 'Drupal\\official_facebook_pixel\\integration\\'.$value;
$class_name::injectPixelCode();
}
}
public static function injectScriptCode($options) {
// Inject inline script code to head
$pixel_script_code = PixelScriptBuilder::getPixelBaseCode();
$pixel_script_code .= PixelScriptBuilder::getPixelInitCode(
$options->getAgentString(),
$options->getUserInfo());
$pixel_script_code .= PixelScriptBuilder::getPixelPageViewCode();
drupal_add_html_head(
[
'#type' => 'markup',
'#markup' => $pixel_script_code,
'#weight' => 1000,
],
'facebook_pixel_script_code');
}
public static function injectNoScriptCode() {
// Inject inline noscript code to head
$pixel_noscript_code = PixelScriptBuilder::getPixelNoscriptCode();
drupal_add_html_head(
[
'#type' => 'markup',
'#markup' => $pixel_noscript_code,
'#weight' => 1000,
],
'facebook_pixel_noscript_code');
}
}

109
frontend/drupal/modules/official_facebook_pixel/src/OfficialFacebookPixelOptions.php Normal file
View File

@ -0,0 +1,109 @@
<?php
/*
* Copyright (C) 2017-present, Facebook, Inc.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; version 2 of the License.
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*/
/**
* @file
* Contains \Drupal\official_facebook_pixel
* \OfficialFacebookPixelOptions.
*/
namespace Drupal\official_facebook_pixel;
use Drupal\official_facebook_pixel\OfficialFacebookPixelConfig;
/**
* Class OfficialFacebookPixelOptions.
*
* @package Drupal\official_facebook_pixel
*/
class OfficialFacebookPixelOptions {
private static $instance = null;
private $options = array();
private $userInfo = array();
private $versionInfo = array();
public static function getInstance() {
if (is_null(self::$instance)) {
self::$instance = new OfficialFacebookPixelOptions();
}
return self::$instance;
}
public function __construct() {
$this->setOptions();
$this->setUserInfo();
$this->setVersionInfo();
}
public function getOptions() {
return $this->options;
}
private function setOptions() {
$this->options = array(
OfficialFacebookPixelConfig::FORM_PIXEL_KEY =>
variable_get(OfficialFacebookPixelConfig::FORM_PIXEL_KEY, '3580569621997173'),
OfficialFacebookPixelConfig::FORM_PII_KEY =>
variable_get(OfficialFacebookPixelConfig::FORM_PII_KEY, 1),
);
}
public function getPixelId() {
return $this->options[OfficialFacebookPixelConfig::FORM_PIXEL_KEY];
}
public function getUsePii() {
return $this->options[OfficialFacebookPixelConfig::FORM_PII_KEY];
}
public function getUserInfo() {
return $this->userInfo;
}
public function setUserInfo() {
global $user;
$use_pii = $this->getUsePii();
if (0 === $user->uid || $use_pii !== 1) {
// User not logged in or admin chose not to send PII.
$this->userInfo = array();
} else {
$this->userInfo = array_filter(
array(
// Keys documented in
// https://developers.facebook.com/docs/facebook-pixel/pixel-with-ads/conversion-tracking#advanced_match
'em' => $user->mail,
),
function ($value) { return $value !== null && $value !== ''; });
}
}
public function getVersionInfo() {
return $this->versionInfo;
}
public function setVersionInfo() {
$this->versionInfo = array(
'source' => OfficialFacebookPixelConfig::SOURCE_7,
'version' => VERSION,
);
}
public function getAgentString() {
return sprintf(
'%s-%s',
$this->versionInfo['source'],
$this->versionInfo['version']);
}
}

39
frontend/drupal/modules/official_facebook_pixel/src/OfficialFacebookPixelUtils.php Normal file
View File

@ -0,0 +1,39 @@
<?php
/*
* Copyright (C) 2017-present, Facebook, Inc.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; version 2 of the License.
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*/
/**
* @file
* Contains \Drupal\official_facebook_pixel
* \OfficialFacebookPixelUtils.
*/
namespace Drupal\official_facebook_pixel;
/**
* Class OfficialFacebookPixelUtils.
*
* @package Drupal\official_facebook_pixel
*/
class OfficialFacebookPixelUtils {
/**
* Returns true if id is a positive non-zero integer
*
* @access public
* @param string $pixel_id
* @return bool
*/
public static function isPositiveInteger($pixel_id) {
return isset($pixel_id) && ctype_digit($pixel_id) && $pixel_id !== '0';
}
}

241
frontend/drupal/modules/official_facebook_pixel/src/PixelScriptBuilder.php Normal file
View File

@ -0,0 +1,241 @@
<?php
/*
* Copyright (C) 2017-present, Facebook, Inc.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; version 2 of the License.
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*/
/**
* @file
* Contains \Drupal\official_facebook_pixel\PixelScriptBuilder.
*/
namespace Drupal\official_facebook_pixel;
/**
* Pixel object
*/
class PixelScriptBuilder {
const ADDPAYMENTINFO = 'AddPaymentInfo';
const ADDTOCART = 'AddToCart';
const ADDTOWISHLIST = 'AddToWishlist';
const COMPLETEREGISTRATION = 'CompleteRegistration';
const CONTACT = 'Contact';
const CUSTOMIZEPRODUCT = 'CustomizeProduct';
const DONATE = 'Donate';
const FINDLOCATION = 'FindLocation';
const INITIATECHECKOUT = 'InitiateCheckout';
const LEAD = 'Lead';
const PAGEVIEW = 'PageView';
const PURCHASE = 'Purchase';
const SCHEDULE = 'Schedule';
const SEARCH = 'Search';
const STARTTRIAL = 'StartTrial';
const SUBMITAPPLICATION = 'SubmitApplication';
const SUBSCRIBE = 'Subscribe';
const VIEWCONTENT = 'ViewContent';
const FB_INTEGRATION_TRACKING_KEY = 'fb_integration_tracking';
private static $pixelId = '';
private static $pixelBaseCode = "
<!-- Facebook Pixel Code -->
<script type='text/javascript'>
!function(f,b,e,v,n,t,s){if(f.fbq)return;n=f.fbq=function(){n.callMethod?
n.callMethod.apply(n,arguments):n.queue.push(arguments)};if(!f._fbq)f._fbq=n;
n.push=n;n.loaded=!0;n.version='2.0';n.queue=[];t=b.createElement(e);t.async=!0;
t.src=v;s=b.getElementsByTagName(e)[0];s.parentNode.insertBefore(t,s)}(window,
document,'script','https://connect.facebook.net/en_US/fbevents.js');
</script>
<!-- End Facebook Pixel Code -->
";
private static $pixelFbqCodeWithoutScript = "
fbq('%s', '%s'%s%s);
";
private static $pixelNoscriptCode = "
<!-- Facebook Pixel Code -->
<noscript>
<img height=\"1\" width=\"1\" style=\"display:none\" alt=\"fbpx\"
src=\"https://www.facebook.com/tr?id=%s&ev=%s%s&noscript=1\" />
</noscript>
<!-- End Facebook Pixel Code -->
";
public static function initialize($pixel_id = '') {
self::$pixelId = $pixel_id;
}
/**
* Gets FB pixel ID
*/
public static function getPixelId() {
return self::$pixelId;
}
/**
* Sets FB pixel ID
*/
public static function setPixelId($pixel_id) {
self::$pixelId = $pixel_id;
}
/**
* Gets FB pixel base code
*/
public static function getPixelBaseCode() {
return self::$pixelBaseCode;
}
/**
* Gets FB pixel init code
*/
public static function getPixelInitCode($agent_string, $param = array(), $with_script_tag = true) {
if (empty(self::$pixelId)) {
return;
}
$code = $with_script_tag
? "<script type='text/javascript'>" . self::$pixelFbqCodeWithoutScript . "</script>"
: self::$pixelFbqCodeWithoutScript;
$param_str = $param;
if (is_array($param)) {
$param_str = json_encode($param, JSON_PRETTY_PRINT);
}
$agent_param = array('agent' => $agent_string);
return sprintf(
$code,
'init',
self::$pixelId,
', ' . $param_str,
', ' . json_encode($agent_param, JSON_PRETTY_PRINT));
}
/**
* Gets FB pixel track code
* $param is the parameter for the pixel event.
* If it is an array, FB_INTEGRATION_TRACKING_KEY parameter with $tracking_name value will automatically
* be added into the $param. If it is a string, please append the FB_INTEGRATION_TRACKING_KEY parameter
* with its tracking name into the JS Parameter block
*/
public static function getPixelTrackCode($event, $param = array(), $tracking_name = '', $with_script_tag = true) {
if (empty(self::$pixelId)) {
return;
}
$code = $with_script_tag
? "<script type='text/javascript'>" . self::$pixelFbqCodeWithoutScript . "</script>"
: self::$pixelFbqCodeWithoutScript;
$param_str = $param;
if (is_array($param)) {
if (!empty($tracking_name)) {
$param[self::FB_INTEGRATION_TRACKING_KEY] = $tracking_name;
}
$param_str = json_encode($param, JSON_PRETTY_PRINT);
}
$class = new \ReflectionClass(__CLASS__);
return sprintf(
$code,
$class->getConstant(strtoupper($event)) !== false ? 'track' : 'trackCustom',
$event,
', ' . $param_str,
'');
}
/**
* Gets FB pixel noscript code
*/
public static function getPixelNoscriptCode($event = 'PageView', $cd = array(), $tracking_name = '') {
if (empty(self::$pixelId)) {
return;
}
$data = '';
foreach ($cd as $k => $v) {
$data .= '&cd[' . $k . ']=' . $v;
}
if (!empty($tracking_name)) {
$data .= '&cd[' . self::FB_INTEGRATION_TRACKING_KEY . ']=' . $tracking_name;
}
return sprintf(
self::$pixelNoscriptCode,
self::$pixelId,
$event,
$data);
}
/**
* Gets FB pixel AddToCart code
*/
public static function getPixelAddToCartCode($param = array(), $tracking_name = '', $with_script_tag = true) {
return self::getPixelTrackCode(
self::ADDTOCART,
$param,
$tracking_name,
$with_script_tag);
}
/**
* Gets FB pixel InitiateCheckout code
*/
public static function getPixelInitiateCheckoutCode($param = array(), $tracking_name = '', $with_script_tag = true) {
return self::getPixelTrackCode(
self::INITIATECHECKOUT,
$param,
$tracking_name,
$with_script_tag);
}
/**
* Gets FB pixel Lead code
*/
public static function getPixelLeadCode($param = array(), $tracking_name = '', $with_script_tag = true) {
return self::getPixelTrackCode(
self::LEAD,
$param,
$tracking_name,
$with_script_tag);
}
/**
* Gets FB pixel PageView code
*/
public static function getPixelPageViewCode($param = array(), $tracking_name = '', $with_script_tag = true) {
return self::getPixelTrackCode(
self::PAGEVIEW,
$param,
$tracking_name,
$with_script_tag);
}
/**
* Gets FB pixel Purchase code
*/
public static function getPixelPurchaseCode($param = array(), $tracking_name = '', $with_script_tag = true) {
return self::getPixelTrackCode(
self::PURCHASE,
$param,
$tracking_name,
$with_script_tag);
}
/**
* Gets FB pixel ViewContent code
*/
public static function getPixelViewContentCode($param = array(), $tracking_name = '', $with_script_tag = true) {
return self::getPixelTrackCode(
self::VIEWCONTENT,
$param,
$tracking_name,
$with_script_tag);
}
}

34
frontend/drupal/modules/official_facebook_pixel/src/integration/FacebookDrupalExample.php Normal file
View File

@ -0,0 +1,34 @@
<?php
/*
* Copyright (C) 2017-present, Facebook, Inc.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; version 2 of the License.
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*/
/**
* @file
* Contains \Drupal\official_facebook_pixel
* \integration\FacebookDrupalExample.
*/
namespace Drupal\official_facebook_pixel\integration;
/**
* Class FacebookDrupalExample.
*
* @package Drupal\official_facebook_pixel\integration
*/
class FacebookDrupalExample extends FacebookDrupalIntegrationBase {
const TRACKING_NAME = 'example';
public static function injectPixelCode() {
}
}

37
frontend/drupal/modules/official_facebook_pixel/src/integration/FacebookDrupalIntegrationBase.php Normal file
View File

@ -0,0 +1,37 @@
<?php
/*
* Copyright (C) 2017-present, Facebook, Inc.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; version 2 of the License.
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*/
/**
* @file
* Contains \Drupal\official_facebook_pixel
* \integration\FacebookDrupalIntegrationBase.
*/
namespace Drupal\official_facebook_pixel\integration;
/**
* Class FacebookDrupalIntegrationBase.
*
* @package Drupal\official_facebook_pixel\integration
*/
abstract class FacebookDrupalIntegrationBase {
const TRACKING_NAME = '';
/**
* inject the pixel code for the plugin
*/
public static function injectPixelCode() {
}
}