diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..84176f4 --- /dev/null +++ b/.gitignore @@ -0,0 +1,324 @@ +# Cache, temp and personal files + +/.htaccess +*.log +npm-debug.log.* +.sass-cache/ +*.swp +*.swo +.cache/ + +# Cache +/cache/* +!/cache/.htaccess +!/cache/cachefs/index.php +!/cache/deprecated.txt +!/cache/index.php +!/cache/purifier/index.php +!/cache/push/activity +!/cache/push/index.php +!/cache/push/trends +!/cache/sandbox/index.php +!/cache/smarty/cache/index.php +!/cache/smarty/compile/index.php +!/cache/smarty/index.php +!/cache/tcpdf/index.php + +# Download +/download/* +!/download/.htaccess +!/download/index.php + +# Images +/img/* +!/img/.htaccess +!/img/index.php +!/img/404.gif +!/img/app_icon.png +!/img/bg_500.png +!/img/bg_loader.png +!/img/favicon.ico +!/img/loader.gif +!/img/loadingAnimation.gif +!/img/logo.jpg +!/img/logo.png +!/img/logo_invoice.jpg +!/img/logo_stores.png +!/img/macFFBgHack.png +!/img/prestashop-avatar.png +!/img/prestashop@2x.png +!/img/preston-login-wink@2x.png +!/img/preston-login@2x.png +!/img/questionmark.png +!/img/genders/index.php +!/img/admin/index.php +!/img/c/index.php +!/img/cms/index.php +!/img/co/index.php +!/img/e/index.php +!/img/jquery-ui +!/img/l/index.php +!/img/m/index.php +!/img/os/index.php +!/img/p/index.php +!/img/s/index.php +!/img/scenes +!/img/st/index.php +!/img/su/index.php +!/img/t/index.php +!/img/tmp/index.php + +# Upload +/upload/* +!/upload/index.php +!/upload/.htaccess + +/vendor/* +/docs/phpdoc-sf/ +/composer.lock +*.hot-update.js +*.hot-update.json + +tests-legacy/resources/modules/followup/ +tests-legacy/resources/modules/ps_emailalerts/ +tests-legacy/resources/modules/ps_emailsubscription/mails/ +tests-legacy/resources/modules/referralprogram/ + +/admin-dev/autoupgrade/* +!/admin-dev/autoupgrade/index.php +!/admin-dev/autoupgrade/backup/index.php + +/admin-dev/backups/* +!/admin-dev/backups/.htaccess + +/admin-dev/import/* +!/admin-dev/import/.htaccess +!/admin-dev/import/index.php + +/admin-dev/export/* +!/admin-dev/export/.htaccess +!/admin-dev/export/index.php + +# Downloaded RTL files +/admin-dev/themes/default/css/bundle/default_rtl.css +/admin-dev/themes/default/css/bundle/shared_rtl.css +/admin-dev/themes/default/css/font_rtl.css +/admin-dev/themes/default/css/overrides_rtl.css +/admin-dev/themes/default/css/vendor/font-awesome/font-awesome_rtl.css +/admin-dev/themes/default/css/vendor/nv.d3_rtl.css +/admin-dev/themes/default/css/vendor/titatoggle-min_rtl.css +/admin-dev/themes/default/public/theme_rtl.css +/admin-dev/themes/default/public/* +/admin-dev/themes/new-theme/css/module/drop_rtl.css +/admin-dev/themes/new-theme/css/right-sidebar_rtl.css +/admin-dev/themes/new-theme/public/* +!/admin-dev/themes/new-theme/public/theme.rtlfix +!/admin-dev/themes/default/public/theme.rtlfix + +themes/*/cache/* +themes/core.js.map +themes/core.js + + +# Config + +config/defines_custom.inc.php +config/settings.inc.php +config/settings.old.php +config/xml/* +config/themes/* +!config/xml/themes/default.xml +themes/*/config/settings_*.json +app/config/parameters.old.yml +app/config/config.php + +# Themes, modules and overrides + +modules/* +override/* +themes/*/ +!themes/classic +themes/classic/assets +!themes/_core +!themes/_libraries +themes/classic/assets/css/*_rtl.css + +# Vendors and dependencies + +bower_components/ +node_modules/ +composer.phar +php-cs-fixer +.grunt/* + +# Translations and emails templates + +translations/* +mails/* +!mails/themes/ +!mails/_partials/ +themes/default-bootstrap/lang/* +themes/default-bootstrap/modules/*/translations/*.php +themes/default-bootstrap/mails/* +!themes/default-bootstrap/mails/en/ +themes/default-bootstrap/modules/*/mails/* +!themes/default-bootstrap/modules/*/mails/en + +# MISC + +*sitemap.xml +/robots.txt + +# Symfony + +/bin/ +/.web-server-pid +/app/Resources/geoip/GeoLite2-City.mmdb +/app/Resources/translations/* +!/app/Resources/translations/default +/app/config/parameters.yml +/app/config/parameters.php +/build/ +/phpunit.xml +/var/* +!/var/cache +/var/cache/* +!var/cache/.gitkeep +!/var/logs +/var/logs/* +!var/logs/.gitkeep +!/var/sessions +/var/sessions/* +!var/sessions/.gitkeep +!var/SymfonyRequirements.php +/vendor/ +/web/bundles/ + + +# Created by https://www.gitignore.io/api/linux,osx,windows,sublimetext,phpstorm + +### Linux ### +*~ + +# KDE directory preferences +.directory + +# Linux trash folder which might appear on any partition or disk +.Trash-* + + +### OSX ### +.DS_Store +.AppleDouble +.LSOverride + +# Icon must end with two \r +Icon + + +# Thumbnails +._* + +# Files that might appear in the root of a volume +.DocumentRevisions-V100 +.fseventsd +.Spotlight-V100 +.TemporaryItems +.Trashes +.VolumeIcon.icns + +# Directories potentially created on remote AFP share +.AppleDB +.AppleDesktop +Network Trash Folder +Temporary Items +.apdisk + + +### Windows ### +# Windows image file caches +Thumbs.db +ehthumbs.db + +# Folder config file +Desktop.ini + +# Recycle Bin used on file shares +$RECYCLE.BIN/ + +# Windows Installer files +*.cab +*.msi +*.msm +*.msp + +# Windows shortcuts +*.lnk + + +### SublimeText ### +# cache files for sublime text +*.tmlanguage.cache +*.tmPreferences.cache +*.stTheme.cache + +# workspace files are user-specific +*.sublime-workspace + +# project files should be checked into the repository, unless a significant +# proportion of contributors will probably not be using SublimeText +# *.sublime-project + +# sftp configuration file +sftp-config.json + + +### PhpStorm ### +# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio + +*.iml + +## Directory-based project format: +.idea/ + +## File-based project format: +*.ipr +*.iws + +## Plugin-specific files: + +# IntelliJ +/out/ + +# mpeltonen/sbt-idea plugin +.idea_modules/ + +# JIRA plugin +atlassian-ide-plugin.xml + +# Crashlytics plugin (for Android Studio and IntelliJ) +com_crashlytics_export_strings.xml +crashlytics.properties +crashlytics-build.properties + +### NetBeans ### +nbproject/ +nbbuild/ +dist/ +nbdist/ +nbactions.xml +nb-configuration.xml +.nb-gradle/ + +### Eclipse ### +.buildpath +.project +.settings/ +.externalToolBuilders/ + +### Release creation ### +tools/build/releases/* +!tools/build/releases/.gitkeep + +## Docker configuration +install.lock diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..fa579bc --- /dev/null +++ b/.travis.yml @@ -0,0 +1,18 @@ +os: linux +language: php +php: 7.1 + +script: composer install +before_deploy: + - mkdir tracksmart + - rsync -avr --exclude='tracksmart' * tracksmart + - zip -r tracksmart.zip tracksmart + +deploy: + provider: releases + api_key: + secure: "uXYDFqUCa02oZBPxka4i3likbfD2izKbV3AEV9wm9khST4o11aah5XzkkUR/tE42szCN9VlHmEBc6FtD/jxkHSeU5Zx7Z6lMjd1/p5UG7CpYKzHs2ma0Z8RlE4j7C0Uaj9Kkq3FBcp3UUl5KQGQhrTnE2iEsuTF0M6jETmcOLjV7aEH/lO0il0mQmKO89B8gIp7vj+pjvKs+oAIsxlqJepgxehCVY8dTBBqvkiYuVB6oe63oG6D8BxsmxtL4Qc6Lmk1FLleiX2O0zXnnpo7E/b1BUzg11yPy3E3MjC4yf5039JLfd6JcHfD9T67v2TYiar+LGXDhToPXuQSx024Y4ZCGNyOp33beSAna780sk9Cd4c2fiGwHtOAOdNkWFhZeQ0KxvbpNSo7O8ZZZ0D3RqTzU8pk/hCiFO6ozNg3cR43+40H0CVDq9XD4yOF73UvVDRW9tPN44V7L+7rc8uX0j6ROaTcZbQ5vhuNjXVFIVgti2kfRtOQXzg9hTcbB+NNVz2AQ/iwV7DGnd8Bs3zz/suJ98c5tUi1/tQxbswVD7Ph6T3oX1ZRO+0oQIZAu3RPXxvERZ5UUj/eWMk8PTCZEHGz8mLOjDyuwV4eQjvWP9QSsnF86JcK5E7njX8al3yZ9UxjHsBH4SuLxWbNuMIm0tGilJASWzAr3y/Z5RozngaA=" + file: tracksmart.zip + skip_cleanup: true + on: + tags: true diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..bc08fe2 --- /dev/null +++ b/LICENSE @@ -0,0 +1,619 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. 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 +them 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 prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. 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. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey 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; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If 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 convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU 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 that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + 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. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +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. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. diff --git a/README.md b/README.md new file mode 100644 index 0000000..f28d370 --- /dev/null +++ b/README.md @@ -0,0 +1,103 @@ +![TrackSmart](logo.png) +# tracksmart-prestashop [![Build Status](https://travis-ci.com/kacperduras/tracksmart-prestashop.svg?branch=main)](https://travis-ci.com/kacperduras/tracksmart-prestashop) + +Module to enhanced tracking for Google Analytics 4 (via Google Tag Manager). + +## Advantages of module +* Very light (no unnecessary libraries) +* Efficient (no database queries) +* Scrupulous (sends necessary information in the correct formats) +* Flexible (e.g.: implementations for Facebook Pixel, simple API in JavaScript, and more) +* Open source + +## Features +* Categories page view +* Products page view +* Products added to cart +* Products removed from cart +* Checkout +* Purchase + +*Google Tag Manager settings provided in module, include example implementations for Google Analytics 4 and Facebook Pixel.* + +## Requirements +* PrestaShop 1.7+ +* PHP 7+ + +## How to set up? + +### PrestaShop +* Download files from releases +* Install in PrestaShop +* Provide Container ID from GTM, mark as ready and save :) + +![General settings](docs/general-settings.png) + +### Google Analytics 4 + +* Create new property (select target country and currency) + +![New property](docs/ga-1.png) + +* Set up new data stream: `Web` + +![Setup new data stream](docs/ga-2.png) + +* Provide details + +![Setup new data stream](docs/ga-3.png) + +* Save `Measurement ID` + +![Measurement ID](docs/ga-4.png) + +### Facebook Pixel + +Create and get ID of Facebook Pixel: [here](https://www.facebook.com/business/help/952192354843755) + +### Google Tag Manager + +* Set up settings from `container.json` file ([help is available here](https://support.google.com/tagmanager/answer/6106997?hl=en)). +* Replace values in variables: + - `(Settings) Google Analytics` to `Measurement ID` + - `(Settings) Facebook Pixel` to ID of Facebook Pixel +* Push tags. Done :) + +## API + +### JSON +* Request URL: `http://yoursite.com/module/tracksmart/ajax` +* Request body: + - id: id of [Product](https://github.com/PrestaShop/PrestaShop/blob/1.7.7.x/classes/Product.php) (required) + - attribute: attribute of [Product](https://github.com/PrestaShop/PrestaShop/blob/1.7.7.x/classes/Product.php) + - customization: customization of [Product](https://github.com/PrestaShop/PrestaShop/blob/1.7.7.x/classes/Product.php) +* Response: +```json +{ + "item_name": "Item name", + "item_id": 12345, + "price": 12.34, + "item_brand": "Brand", + "item_category": "Category", + "item_variant": "Variant", + "quantity": 1 +} +``` +* Exceptions: + - 400: `Bad Request` + +### JavaScript + +In `header`, module create instance of `TrackSmart` as variable `trackSmart`. + +```javascript +let trackSmart = new TrackSmart('CONTAINER_ID', 'USER_ID'); // 'USER_ID' is optional +trackSmart.build(); // Initialize connection +trackSmart.process('event_name', { + ecommerce: 'event_body' +}); // Send request to Google Tag Manager +trackSmart.destroy(); // Destroy session +``` + +## License +[GNU General Public License v3.0](LICENSE) diff --git a/composer.json b/composer.json new file mode 100644 index 0000000..1ac07a1 --- /dev/null +++ b/composer.json @@ -0,0 +1,20 @@ +{ + "name": "kacperduras/tracksmart-prestashop", + "description": "Module to enhanced tracking for Google Analytics 4 (via Google Tag Manager)", + "authors": [ + { + "name": "Kacper Duras", + "email": "contact@kacperduras.pl" + } + ], + "require": { + "php": ">=7.1", + "ext-json": "*" + }, + "config": { + "preferred-install": "dist", + "prepend-autoloader": false + }, + "type": "prestashop-module", + "license": "GNU General Public License v3.0" +} diff --git a/config.xml b/config.xml new file mode 100644 index 0000000..c0c3de8 --- /dev/null +++ b/config.xml @@ -0,0 +1,13 @@ + + + tracksmart + + + + + + + + 1 + 1 + diff --git a/container.json b/container.json new file mode 100644 index 0000000..5f1e1e9 --- /dev/null +++ b/container.json @@ -0,0 +1,1281 @@ +{ + "exportFormatVersion": 2, + "exportTime": "2020-11-04 02:46:08", + "containerVersion": { + "path": "accounts/6001067005/containers/33802165/versions/0", + "accountId": "6001067005", + "containerId": "33802165", + "containerVersionId": "0", + "container": { + "path": "accounts/6001067005/containers/33802165", + "accountId": "6001067005", + "containerId": "33802165", + "name": "kacperduras-usermd-3", + "publicId": "GTM-PTRHWNX", + "usageContext": [ + "WEB" + ], + "fingerprint": "1603783975475", + "tagManagerUrl": "https://tagmanager.google.com/#/container/accounts/6001067005/containers/33802165/workspaces?apiLink=container" + }, + "tag": [ + { + "accountId": "6001067005", + "containerId": "33802165", + "tagId": "4", + "name": "Google Analytics", + "type": "gaawc", + "priority": { + "type": "INTEGER", + "value": "100" + }, + "parameter": [ + { + "type": "LIST", + "key": "fieldsToSet", + "list": [ + { + "type": "MAP", + "map": [ + { + "type": "TEMPLATE", + "key": "name", + "value": "user_id" + }, + { + "type": "TEMPLATE", + "key": "value", + "value": "{{User}}" + } + ] + } + ] + }, + { + "type": "BOOLEAN", + "key": "sendPageView", + "value": "true" + }, + { + "type": "TEMPLATE", + "key": "measurementId", + "value": "{{(Settings) Google Analytics}}" + } + ], + "fingerprint": "1604445645624", + "firingTriggerId": [ + "2147479553" + ], + "tagFiringOption": "ONCE_PER_EVENT", + "monitoringMetadata": { + "type": "MAP" + } + }, + { + "accountId": "6001067005", + "containerId": "33802165", + "tagId": "15", + "name": "Google Analytics - ViewItem", + "type": "gaawe", + "priority": { + "type": "INTEGER", + "value": "99" + }, + "parameter": [ + { + "type": "TEMPLATE", + "key": "eventName", + "value": "view_item" + }, + { + "type": "LIST", + "key": "eventParameters", + "list": [ + { + "type": "MAP", + "map": [ + { + "type": "TEMPLATE", + "key": "name", + "value": "items" + }, + { + "type": "TEMPLATE", + "key": "value", + "value": "{{Items}}" + } + ] + }, + { + "type": "MAP", + "map": [ + { + "type": "TEMPLATE", + "key": "name", + "value": "currency" + }, + { + "type": "TEMPLATE", + "key": "value", + "value": "{{Currency}}" + } + ] + } + ] + }, + { + "type": "TAG_REFERENCE", + "key": "measurementId", + "value": "Google Analytics" + } + ], + "fingerprint": "1603906451912", + "firingTriggerId": [ + "11" + ], + "tagFiringOption": "ONCE_PER_EVENT", + "monitoringMetadata": { + "type": "MAP" + } + }, + { + "accountId": "6001067005", + "containerId": "33802165", + "tagId": "16", + "name": "Google Analytics - AddToCart", + "type": "gaawe", + "priority": { + "type": "INTEGER", + "value": "99" + }, + "parameter": [ + { + "type": "TEMPLATE", + "key": "eventName", + "value": "add_to_cart" + }, + { + "type": "LIST", + "key": "eventParameters", + "list": [ + { + "type": "MAP", + "map": [ + { + "type": "TEMPLATE", + "key": "name", + "value": "items" + }, + { + "type": "TEMPLATE", + "key": "value", + "value": "{{Items}}" + } + ] + }, + { + "type": "MAP", + "map": [ + { + "type": "TEMPLATE", + "key": "name", + "value": "currency" + }, + { + "type": "TEMPLATE", + "key": "value", + "value": "{{Currency}}" + } + ] + } + ] + }, + { + "type": "TAG_REFERENCE", + "key": "measurementId", + "value": "Google Analytics" + } + ], + "fingerprint": "1603906404144", + "firingTriggerId": [ + "12" + ], + "tagFiringOption": "ONCE_PER_EVENT", + "monitoringMetadata": { + "type": "MAP" + } + }, + { + "accountId": "6001067005", + "containerId": "33802165", + "tagId": "17", + "name": "Google Analytics - BeginCheckout", + "type": "gaawe", + "priority": { + "type": "INTEGER", + "value": "99" + }, + "parameter": [ + { + "type": "TEMPLATE", + "key": "eventName", + "value": "begin_checkout" + }, + { + "type": "LIST", + "key": "eventParameters", + "list": [ + { + "type": "MAP", + "map": [ + { + "type": "TEMPLATE", + "key": "name", + "value": "items" + }, + { + "type": "TEMPLATE", + "key": "value", + "value": "{{Items}}" + } + ] + }, + { + "type": "MAP", + "map": [ + { + "type": "TEMPLATE", + "key": "name", + "value": "currency" + }, + { + "type": "TEMPLATE", + "key": "value", + "value": "{{Currency}}" + } + ] + } + ] + }, + { + "type": "TAG_REFERENCE", + "key": "measurementId", + "value": "Google Analytics" + } + ], + "fingerprint": "1603906420376", + "firingTriggerId": [ + "13" + ], + "tagFiringOption": "ONCE_PER_EVENT", + "monitoringMetadata": { + "type": "MAP" + } + }, + { + "accountId": "6001067005", + "containerId": "33802165", + "tagId": "18", + "name": "Google Analytics - Purchase", + "type": "gaawe", + "priority": { + "type": "INTEGER", + "value": "99" + }, + "parameter": [ + { + "type": "TEMPLATE", + "key": "eventName", + "value": "purchase" + }, + { + "type": "LIST", + "key": "eventParameters", + "list": [ + { + "type": "MAP", + "map": [ + { + "type": "TEMPLATE", + "key": "name", + "value": "items" + }, + { + "type": "TEMPLATE", + "key": "value", + "value": "{{Items}}" + } + ] + }, + { + "type": "MAP", + "map": [ + { + "type": "TEMPLATE", + "key": "name", + "value": "transaction_id" + }, + { + "type": "TEMPLATE", + "key": "value", + "value": "{{TransactionId}}" + } + ] + }, + { + "type": "MAP", + "map": [ + { + "type": "TEMPLATE", + "key": "name", + "value": "value" + }, + { + "type": "TEMPLATE", + "key": "value", + "value": "{{Value}}" + } + ] + }, + { + "type": "MAP", + "map": [ + { + "type": "TEMPLATE", + "key": "name", + "value": "tax" + }, + { + "type": "TEMPLATE", + "key": "value", + "value": "{{Tax}}" + } + ] + }, + { + "type": "MAP", + "map": [ + { + "type": "TEMPLATE", + "key": "name", + "value": "shipping" + }, + { + "type": "TEMPLATE", + "key": "value", + "value": "{{Shipping}}" + } + ] + }, + { + "type": "MAP", + "map": [ + { + "type": "TEMPLATE", + "key": "name", + "value": "currency" + }, + { + "type": "TEMPLATE", + "key": "value", + "value": "{{Currency}}" + } + ] + } + ] + }, + { + "type": "TAG_REFERENCE", + "key": "measurementId", + "value": "Google Analytics" + } + ], + "fingerprint": "1603906439954", + "firingTriggerId": [ + "14" + ], + "tagFiringOption": "ONCE_PER_EVENT", + "monitoringMetadata": { + "type": "MAP" + } + }, + { + "accountId": "6001067005", + "containerId": "33802165", + "tagId": "24", + "name": "Facebook Pixel", + "type": "html", + "priority": { + "type": "INTEGER", + "value": "100" + }, + "parameter": [ + { + "type": "TEMPLATE", + "key": "html", + "value": "" + }, + { + "type": "BOOLEAN", + "key": "supportDocumentWrite", + "value": "false" + } + ], + "fingerprint": "1604445557497", + "firingTriggerId": [ + "2147479553" + ], + "tagFiringOption": "ONCE_PER_EVENT", + "monitoringMetadata": { + "type": "MAP" + } + }, + { + "accountId": "6001067005", + "containerId": "33802165", + "tagId": "26", + "name": "Facebook Pixel - ViewItem", + "type": "html", + "priority": { + "type": "INTEGER", + "value": "99" + }, + "parameter": [ + { + "type": "TEMPLATE", + "key": "html", + "value": "" + }, + { + "type": "BOOLEAN", + "key": "supportDocumentWrite", + "value": "false" + } + ], + "fingerprint": "1603906559614", + "firingTriggerId": [ + "11" + ], + "tagFiringOption": "ONCE_PER_EVENT", + "monitoringMetadata": { + "type": "MAP" + } + }, + { + "accountId": "6001067005", + "containerId": "33802165", + "tagId": "28", + "name": "Facebook Pixel - AddToCart", + "type": "html", + "priority": { + "type": "INTEGER", + "value": "99" + }, + "parameter": [ + { + "type": "TEMPLATE", + "key": "html", + "value": "" + }, + { + "type": "BOOLEAN", + "key": "supportDocumentWrite", + "value": "false" + } + ], + "fingerprint": "1603906519595", + "firingTriggerId": [ + "12" + ], + "tagFiringOption": "ONCE_PER_EVENT", + "monitoringMetadata": { + "type": "MAP" + } + }, + { + "accountId": "6001067005", + "containerId": "33802165", + "tagId": "30", + "name": "Facebook Pixel - BeginCheckout", + "type": "html", + "priority": { + "type": "INTEGER", + "value": "99" + }, + "parameter": [ + { + "type": "TEMPLATE", + "key": "html", + "value": "" + }, + { + "type": "BOOLEAN", + "key": "supportDocumentWrite", + "value": "false" + } + ], + "fingerprint": "1603907419938", + "firingTriggerId": [ + "13" + ], + "tagFiringOption": "ONCE_PER_EVENT", + "monitoringMetadata": { + "type": "MAP" + } + }, + { + "accountId": "6001067005", + "containerId": "33802165", + "tagId": "31", + "name": "Facebook Pixel - Purchase", + "type": "html", + "priority": { + "type": "INTEGER", + "value": "99" + }, + "parameter": [ + { + "type": "TEMPLATE", + "key": "html", + "value": "" + }, + { + "type": "BOOLEAN", + "key": "supportDocumentWrite", + "value": "false" + } + ], + "fingerprint": "1603907429696", + "firingTriggerId": [ + "14" + ], + "tagFiringOption": "ONCE_PER_EVENT", + "monitoringMetadata": { + "type": "MAP" + } + }, + { + "accountId": "6001067005", + "containerId": "33802165", + "tagId": "36", + "name": "Google Analytics - RemoveFromCart", + "type": "gaawe", + "priority": { + "type": "INTEGER", + "value": "99" + }, + "parameter": [ + { + "type": "TEMPLATE", + "key": "eventName", + "value": "remove_from_cart" + }, + { + "type": "LIST", + "key": "eventParameters", + "list": [ + { + "type": "MAP", + "map": [ + { + "type": "TEMPLATE", + "key": "name", + "value": "items" + }, + { + "type": "TEMPLATE", + "key": "value", + "value": "{{Items}}" + } + ] + }, + { + "type": "MAP", + "map": [ + { + "type": "TEMPLATE", + "key": "name", + "value": "currency" + }, + { + "type": "TEMPLATE", + "key": "value", + "value": "{{Currency}}" + } + ] + } + ] + }, + { + "type": "TAG_REFERENCE", + "key": "measurementId", + "value": "Google Analytics" + } + ], + "fingerprint": "1604445871069", + "firingTriggerId": [ + "35" + ], + "tagFiringOption": "ONCE_PER_EVENT", + "monitoringMetadata": { + "type": "MAP" + } + } + ], + "trigger": [ + { + "accountId": "6001067005", + "containerId": "33802165", + "triggerId": "11", + "name": "ViewItem", + "type": "CUSTOM_EVENT", + "customEventFilter": [ + { + "type": "EQUALS", + "parameter": [ + { + "type": "TEMPLATE", + "key": "arg0", + "value": "{{_event}}" + }, + { + "type": "TEMPLATE", + "key": "arg1", + "value": "view_item" + } + ] + } + ], + "filter": [ + { + "type": "EQUALS", + "parameter": [ + { + "type": "TEMPLATE", + "key": "arg0", + "value": "{{Event}}" + }, + { + "type": "TEMPLATE", + "key": "arg1", + "value": "view_item" + } + ] + } + ], + "fingerprint": "1603784849182" + }, + { + "accountId": "6001067005", + "containerId": "33802165", + "triggerId": "12", + "name": "AddToCart", + "type": "CUSTOM_EVENT", + "customEventFilter": [ + { + "type": "EQUALS", + "parameter": [ + { + "type": "TEMPLATE", + "key": "arg0", + "value": "{{_event}}" + }, + { + "type": "TEMPLATE", + "key": "arg1", + "value": "add_to_cart" + } + ] + } + ], + "filter": [ + { + "type": "EQUALS", + "parameter": [ + { + "type": "TEMPLATE", + "key": "arg0", + "value": "{{Event}}" + }, + { + "type": "TEMPLATE", + "key": "arg1", + "value": "add_to_cart" + } + ] + } + ], + "fingerprint": "1603784867968" + }, + { + "accountId": "6001067005", + "containerId": "33802165", + "triggerId": "13", + "name": "BeginCheckout", + "type": "CUSTOM_EVENT", + "customEventFilter": [ + { + "type": "EQUALS", + "parameter": [ + { + "type": "TEMPLATE", + "key": "arg0", + "value": "{{_event}}" + }, + { + "type": "TEMPLATE", + "key": "arg1", + "value": "begin_checkout" + } + ] + } + ], + "filter": [ + { + "type": "EQUALS", + "parameter": [ + { + "type": "TEMPLATE", + "key": "arg0", + "value": "{{Event}}" + }, + { + "type": "TEMPLATE", + "key": "arg1", + "value": "begin_checkout" + } + ] + } + ], + "fingerprint": "1603784940270" + }, + { + "accountId": "6001067005", + "containerId": "33802165", + "triggerId": "14", + "name": "Purchase", + "type": "CUSTOM_EVENT", + "customEventFilter": [ + { + "type": "EQUALS", + "parameter": [ + { + "type": "TEMPLATE", + "key": "arg0", + "value": "{{_event}}" + }, + { + "type": "TEMPLATE", + "key": "arg1", + "value": "purchase" + } + ] + } + ], + "filter": [ + { + "type": "EQUALS", + "parameter": [ + { + "type": "TEMPLATE", + "key": "arg0", + "value": "{{Event}}" + }, + { + "type": "TEMPLATE", + "key": "arg1", + "value": "purchase" + } + ] + } + ], + "fingerprint": "1603784962047" + }, + { + "accountId": "6001067005", + "containerId": "33802165", + "triggerId": "35", + "name": "RemoveFromCart", + "type": "CUSTOM_EVENT", + "customEventFilter": [ + { + "type": "EQUALS", + "parameter": [ + { + "type": "TEMPLATE", + "key": "arg0", + "value": "{{_event}}" + }, + { + "type": "TEMPLATE", + "key": "arg1", + "value": "remove_from_cart" + } + ] + } + ], + "filter": [ + { + "type": "EQUALS", + "parameter": [ + { + "type": "TEMPLATE", + "key": "arg0", + "value": "{{Event}}" + }, + { + "type": "TEMPLATE", + "key": "arg1", + "value": "remove_from_cart" + } + ] + } + ], + "fingerprint": "1604445740917" + } + ], + "variable": [ + { + "accountId": "6001067005", + "containerId": "33802165", + "variableId": "3", + "name": "(Settings) Google Analytics", + "type": "c", + "parameter": [ + { + "type": "TEMPLATE", + "key": "value", + "value": "000000000000000000" + } + ], + "fingerprint": "1604445503357", + "formatValue": {} + }, + { + "accountId": "6001067005", + "containerId": "33802165", + "variableId": "5", + "name": "TransactionId", + "type": "v", + "parameter": [ + { + "type": "INTEGER", + "key": "dataLayerVersion", + "value": "2" + }, + { + "type": "BOOLEAN", + "key": "setDefaultValue", + "value": "false" + }, + { + "type": "TEMPLATE", + "key": "name", + "value": "ecommerce.transaction_id" + } + ], + "fingerprint": "1603785115525", + "formatValue": {} + }, + { + "accountId": "6001067005", + "containerId": "33802165", + "variableId": "6", + "name": "Affiliation", + "type": "v", + "parameter": [ + { + "type": "INTEGER", + "key": "dataLayerVersion", + "value": "2" + }, + { + "type": "BOOLEAN", + "key": "setDefaultValue", + "value": "false" + }, + { + "type": "TEMPLATE", + "key": "name", + "value": "ecommerce.affiliation" + } + ], + "fingerprint": "1603785092302", + "formatValue": {} + }, + { + "accountId": "6001067005", + "containerId": "33802165", + "variableId": "7", + "name": "Value", + "type": "v", + "parameter": [ + { + "type": "INTEGER", + "key": "dataLayerVersion", + "value": "2" + }, + { + "type": "BOOLEAN", + "key": "setDefaultValue", + "value": "false" + }, + { + "type": "TEMPLATE", + "key": "name", + "value": "ecommerce.value" + } + ], + "fingerprint": "1603785122809", + "formatValue": {} + }, + { + "accountId": "6001067005", + "containerId": "33802165", + "variableId": "8", + "name": "Tax", + "type": "v", + "parameter": [ + { + "type": "INTEGER", + "key": "dataLayerVersion", + "value": "2" + }, + { + "type": "BOOLEAN", + "key": "setDefaultValue", + "value": "false" + }, + { + "type": "TEMPLATE", + "key": "name", + "value": "ecommerce.tax" + } + ], + "fingerprint": "1603785108532", + "formatValue": {} + }, + { + "accountId": "6001067005", + "containerId": "33802165", + "variableId": "9", + "name": "Shipping", + "type": "v", + "parameter": [ + { + "type": "INTEGER", + "key": "dataLayerVersion", + "value": "2" + }, + { + "type": "BOOLEAN", + "key": "setDefaultValue", + "value": "false" + }, + { + "type": "TEMPLATE", + "key": "name", + "value": "ecommerce.shipping" + } + ], + "fingerprint": "1603785098808", + "formatValue": {} + }, + { + "accountId": "6001067005", + "containerId": "33802165", + "variableId": "10", + "name": "Items", + "type": "v", + "parameter": [ + { + "type": "INTEGER", + "key": "dataLayerVersion", + "value": "2" + }, + { + "type": "BOOLEAN", + "key": "setDefaultValue", + "value": "false" + }, + { + "type": "TEMPLATE", + "key": "name", + "value": "ecommerce.items" + } + ], + "fingerprint": "1603785080907", + "formatValue": {} + }, + { + "accountId": "6001067005", + "containerId": "33802165", + "variableId": "19", + "name": "[Array] ItemId", + "type": "jsm", + "parameter": [ + { + "type": "TEMPLATE", + "key": "javascript", + "value": "function() \n{ \n return {{Items}}.map(function(target) \n {\n return target.item_id;\n }); \n}\n" + } + ], + "fingerprint": "1603786823521", + "formatValue": {} + }, + { + "accountId": "6001067005", + "containerId": "33802165", + "variableId": "20", + "name": "[Single] ItemId", + "type": "v", + "parameter": [ + { + "type": "INTEGER", + "key": "dataLayerVersion", + "value": "2" + }, + { + "type": "BOOLEAN", + "key": "setDefaultValue", + "value": "false" + }, + { + "type": "TEMPLATE", + "key": "name", + "value": "ecommerce.items.0.item_id" + } + ], + "fingerprint": "1603786792394", + "formatValue": {} + }, + { + "accountId": "6001067005", + "containerId": "33802165", + "variableId": "21", + "name": "[Single] Price", + "type": "v", + "parameter": [ + { + "type": "INTEGER", + "key": "dataLayerVersion", + "value": "2" + }, + { + "type": "BOOLEAN", + "key": "setDefaultValue", + "value": "false" + }, + { + "type": "TEMPLATE", + "key": "name", + "value": "ecommerce.items.0.price" + } + ], + "fingerprint": "1603786805202", + "formatValue": {} + }, + { + "accountId": "6001067005", + "containerId": "33802165", + "variableId": "22", + "name": "[Single] Quantity", + "type": "v", + "parameter": [ + { + "type": "INTEGER", + "key": "dataLayerVersion", + "value": "2" + }, + { + "type": "BOOLEAN", + "key": "setDefaultValue", + "value": "false" + }, + { + "type": "TEMPLATE", + "key": "name", + "value": "ecommerce.items.0.quantity" + } + ], + "fingerprint": "1603786798957", + "formatValue": {} + }, + { + "accountId": "6001067005", + "containerId": "33802165", + "variableId": "23", + "name": "(Settings) Facebook Pixel", + "type": "c", + "parameter": [ + { + "type": "TEMPLATE", + "key": "value", + "value": "000000000000000000" + } + ], + "fingerprint": "1604445494651", + "formatValue": {} + }, + { + "accountId": "6001067005", + "containerId": "33802165", + "variableId": "25", + "name": "[Single] ItemCategory", + "type": "v", + "parameter": [ + { + "type": "INTEGER", + "key": "dataLayerVersion", + "value": "2" + }, + { + "type": "BOOLEAN", + "key": "setDefaultValue", + "value": "false" + }, + { + "type": "TEMPLATE", + "key": "name", + "value": "ecommerce.items.0.item_category" + } + ], + "fingerprint": "1603787003351", + "formatValue": {} + }, + { + "accountId": "6001067005", + "containerId": "33802165", + "variableId": "27", + "name": "[Single] ItemName", + "type": "v", + "parameter": [ + { + "type": "INTEGER", + "key": "dataLayerVersion", + "value": "2" + }, + { + "type": "BOOLEAN", + "key": "setDefaultValue", + "value": "false" + }, + { + "type": "TEMPLATE", + "key": "name", + "value": "ecommerce.items.0.item_name" + } + ], + "fingerprint": "1603787720951", + "formatValue": {} + }, + { + "accountId": "6001067005", + "containerId": "33802165", + "variableId": "29", + "name": "[Array] Price", + "type": "jsm", + "parameter": [ + { + "type": "TEMPLATE", + "key": "javascript", + "value": "function() \n{\n var result = 0;\n \n {{Items}}.forEach(function(target) \n {\n result =+ target.price;\n }); \n \n return result;\n}\n" + } + ], + "fingerprint": "1603789448761", + "formatValue": {} + }, + { + "accountId": "6001067005", + "containerId": "33802165", + "variableId": "32", + "name": "Currency", + "type": "v", + "parameter": [ + { + "type": "INTEGER", + "key": "dataLayerVersion", + "value": "2" + }, + { + "type": "BOOLEAN", + "key": "setDefaultValue", + "value": "false" + }, + { + "type": "TEMPLATE", + "key": "name", + "value": "ecommerce.currency" + } + ], + "fingerprint": "1603906327322", + "formatValue": {} + }, + { + "accountId": "6001067005", + "containerId": "33802165", + "variableId": "33", + "name": "User", + "type": "v", + "parameter": [ + { + "type": "INTEGER", + "key": "dataLayerVersion", + "value": "2" + }, + { + "type": "BOOLEAN", + "key": "setDefaultValue", + "value": "false" + }, + { + "type": "TEMPLATE", + "key": "name", + "value": "user_id" + } + ], + "fingerprint": "1604445397677", + "formatValue": { + "convertUndefinedToValue": { + "type": "TEMPLATE", + "value": "null" + } + } + } + ], + "builtInVariable": [ + { + "accountId": "6001067005", + "containerId": "33802165", + "type": "PAGE_URL", + "name": "Page URL" + }, + { + "accountId": "6001067005", + "containerId": "33802165", + "type": "PAGE_HOSTNAME", + "name": "Page Hostname" + }, + { + "accountId": "6001067005", + "containerId": "33802165", + "type": "PAGE_PATH", + "name": "Page Path" + }, + { + "accountId": "6001067005", + "containerId": "33802165", + "type": "REFERRER", + "name": "Referrer" + }, + { + "accountId": "6001067005", + "containerId": "33802165", + "type": "EVENT", + "name": "Event" + } + ], + "fingerprint": "1604457968299", + "tagManagerUrl": "https://tagmanager.google.com/#/versions/accounts/6001067005/containers/33802165/versions/0?apiLink=version" + } +} diff --git a/controllers/front/ajax.php b/controllers/front/ajax.php new file mode 100644 index 0000000..3cbb763 --- /dev/null +++ b/controllers/front/ajax.php @@ -0,0 +1,64 @@ + 0) + { + $data = (new CartPresenter())->present($this->context->cart); + + foreach ($data['products'] as $target) + { + if ($target['id_product'] == $id && $target['id_product_attribute'] == $attribute + && $target['id_customization'] == $customization) + { + $product = $target; + break; + } + } + } + + if ($product == null) + { + $product = (new ObjectPresenter())->present(new Product($id, true, $this->context->language->id)); + } + $category = new Category($product['id_category_default'], $this->context->language->id); + + ob_end_clean(); + header('Content-Type: application/json'); + + die(Tools::jsonEncode( + array( + 'item_name' => Tools::replaceAccentedChars($product['name']), + 'item_id' => $customization > 0 ? $product['id_product'] : $product['id'], + 'price' => ((double) $product['price']), + 'item_brand' => $product['manufacturer_name'] ?? null, + 'item_category' => $category->name, + 'item_variant' => $product['attributes_small'] ?? null, + 'quantity' => $customization > 0 ? $product['quantity'] : $product['minimal_quantity'] + ) + )); + } + +} diff --git a/docs/ga-1.png b/docs/ga-1.png new file mode 100644 index 0000000..a534566 Binary files /dev/null and b/docs/ga-1.png differ diff --git a/docs/ga-2.png b/docs/ga-2.png new file mode 100644 index 0000000..f1a4e91 Binary files /dev/null and b/docs/ga-2.png differ diff --git a/docs/ga-3.png b/docs/ga-3.png new file mode 100644 index 0000000..96a2595 Binary files /dev/null and b/docs/ga-3.png differ diff --git a/docs/ga-4.png b/docs/ga-4.png new file mode 100644 index 0000000..19e07eb Binary files /dev/null and b/docs/ga-4.png differ diff --git a/docs/general-settings.png b/docs/general-settings.png new file mode 100644 index 0000000..2f8ed8f Binary files /dev/null and b/docs/general-settings.png differ diff --git a/index.php b/index.php new file mode 100644 index 0000000..61ffa71 --- /dev/null +++ b/index.php @@ -0,0 +1,10 @@ + array( + 'type' => 'switch', + 'label' => 'State', + 'is_bool' => true, + 'desc' => 'General state of the module', + 'values' => array( + array( + 'id' => 'active_on', + 'value' => true, + 'label' => 'Enabled' + ), + array( + 'id' => 'active_off', + 'value' => false, + 'label' => 'Disabled' + ), + ), + ), + + 'TRACKSMART_ID' => array( + 'type' => 'text', + 'label' => 'Container ID', + 'desc' => 'Format: GTM-XXXXXX', + 'required' => true + ) + ]; + + public function __construct() + { + $this->name = 'tracksmart'; + $this->tab = 'analytics_stats'; + $this->module_key = 'dc5b9ea5c7aeb8266461cf40270cc604'; + $this->version = '1.0.0'; + $this->author = 'Kacper Duras'; + $this->need_instance = 1; + + $this->bootstrap = true; + + parent::__construct(); + + $this->displayName = $this->l('TrackSmart'); + $this->description = $this->l('Module to enhanced tracking for Google Analytics 4 (via Google Tag Manager)'); + + $this->ps_versions_compliancy = array('min' => '1.7', 'max' => _PS_VERSION_); + } + + public function install() + { + foreach ($this->configuration_fields as $key => $value) + { + if ($value != null) + { + $boolean = $value['boolean'] ?? false; + Configuration::updateValue($key, $boolean ? false : ''); + } + } + + return parent::install() && + $this->registerHook('actionFrontControllerSetMedia') && + $this->registerHook('header'); + } + + public function uninstall() + { + foreach ($this->configuration_fields as $key => $value) + { + Configuration::deleteByName($key); + } + + return parent::uninstall(); + } + + public function getContent() + { + $this->context->smarty->assign('module_dir', $this->_path); + $output = $this->context->smarty->fetch($this->local_path . 'views/templates/admin/configure.tpl'); + + if (Tools::isSubmit('submitTrackSmart')) + { + $state = Tools::getValue('TRACKSMART_STATE'); + $container = Tools::getValue('TRACKSMART_ID'); + + if ($state && ($container == null || empty($container) || !substr($container, 0, 4 ) == "GTM-")) + { + $output .= $this->displayError('Please, provide valid format of container ID'); + } + else + { + foreach (array_keys($this->configuration_fields) as $key) + { + Configuration::updateValue($key, Tools::getValue($key)); + } + + $output .= $this->displayConfirmation('Settings updated'); + } + } + + $helper = new HelperForm(); + + $helper->show_toolbar = false; + $helper->table = $this->table; + $helper->module = $this; + $helper->default_form_language = $this->context->language->id; + $helper->allow_employee_form_lang = Configuration::get('PS_BO_ALLOW_EMPLOYEE_FORM_LANG', 0); + + $helper->identifier = $this->identifier; + $helper->submit_action = 'submitTrackSmart'; + $helper->currentIndex = $this->context->link->getAdminLink('AdminModules', false) + . '&configure=' . $this->name . '&tab_module=' . $this->tab . '&module_name=' . $this->name; + $helper->token = Tools::getAdminTokenLite('AdminModules'); + + $vars = array(); + $input = array(); + + foreach ($this->configuration_fields as $key => $value) + { + $vars[$key] = Configuration::get($key); + + $value['name'] = $key; + array_push($input, $value); + } + + $helper->tpl_vars = array( + 'fields_value' => $vars, + 'languages' => $this->context->controller->getLanguages(), + 'id_language' => $this->context->language->id + ); + + return $output . $helper->generateForm( + array( + array( + 'form' => array( + 'legend' => array( + 'title' => 'General settings', + 'icon' => 'icon-cogs', + ), + + 'input' => $input, + + 'submit' => array( + 'title' => 'Save', + ), + ), + ) + )); + } + + public function hookActionFrontControllerSetMedia() + { + if (!Configuration::get('TRACKSMART_STATE')) + { + return; + } + + $this->context->controller->registerJavascript('tracksmart_sdk', + 'modules/' . $this->name . '/views/js/sdk.js', array('position' => 'head', 'priority' => 100)); + $this->context->controller->registerJavascript('tracksmart_front', + 'modules/' . $this->name . '/views/js/front.js', array('position' => 'bottom', 'priority' => 100)); + } + + public function hookHeader() + { + if (!Configuration::get('TRACKSMART_STATE')) + { + return; + } + + $controller = $this->context->controller->php_self; + if (empty($controller)) + { + $controller = Tools::getValue('controller'); + } + + $event = array('data' => array()); + if ($controller === 'cart') + { + $event['name'] = 'begin_checkout'; + $event['data']['currency'] = $this->context->currency->iso_code; + + $products = array(); + + foreach ($this->context->cart->getProducts() as $product) + { + $category = new Category($product['id_category_default'], $this->context->language->id); + + array_push($products, array( + 'item_name' => Tools::replaceAccentedChars($product['name']), + 'item_id' => $product['id_product'], + 'price' => ((double) $product['price']), + 'item_brand' => $product['manufacturer_name'] ?? null, + 'item_category' => $category->name, + 'item_variant' => $product['attributes_small'] ?? null, + 'quantity' => $product['quantity'] + )); + } + + $event['data']['items'] = $products; + } + elseif ($controller === 'order-confirmation') + { + $id_order = Tools::getValue('id_order'); + if ($id_order != null) + { + $cart = new Cart(Order::getCartIdStatic($id_order, $this->context->customer->id)); + + $event['name'] = 'purchase'; + $event['data']['currency'] = $this->context->currency->iso_code; + + $products = array(); + + foreach ($cart->getProducts() as $product) + { + $category = new Category($product['id_category_default'], $this->context->language->id); + + array_push($products, array( + 'item_name' => Tools::replaceAccentedChars($product['name']), + 'item_id' => $product['id_product'], + 'price' => ((double) $product['price']), + 'item_brand' => $product['manufacturer_name'] ?? null, + 'item_category' => $category->name, + 'item_variant' => $product['attributes_small'] ?? null, + 'quantity' => $product['quantity'] + )); + } + + $coupons = array(); + foreach ($cart->getCartRules() as $target) + { + $coupons[] = $target['name']; + } + + $event['data']['transaction_id'] = $id_order; + $event['data']['affiliation'] = Configuration::get('PS_SHOP_NAME'); + $event['data']['currency'] = $this->context->currency->iso_code; + $event['data']['value'] = ((double) $cart->getOrderTotal(false, Cart::BOTH_WITHOUT_SHIPPING)); + $event['data']['tax'] = (((double) $cart->getOrderTotal(true)) - ((double) $cart->getOrderTotal(false))); + $event['data']['shipping'] = ((double) $cart->getOrderTotal(false, Cart::ONLY_SHIPPING)); + $event['data']['coupon'] = implode(' | ', $coupons); + $event['data']['items'] = $products; + } + } + elseif ($controller === 'product') + { + $product = $this->context->controller->getTemplateVarProduct(); + $category = new Category($product['id_category_default'], $this->context->language->id); + + $event['name'] = 'view_item'; + $event['data']['currency'] = $this->context->currency->iso_code; + $event['data']['items'] = array(array( + 'item_name' => Tools::replaceAccentedChars($product['name']), + 'item_id' => $product['id_product'], + 'price' => ((double) $product['price_amount']), + 'item_brand' => $product['manufacturer_name'] ?? null, + 'item_category' => $category->name, + 'item_variant' => $product['attributes_small'] ?? null, + 'quantity' => $product['minimal_quantity'] + )); + } + else if ($controller == 'category') + { + $page = Tools::getIsset('page') ? Tools::getValue('page') : 1; + $limit = Configuration::get('PS_PRODUCTS_PER_PAGE') ?? 12; + $products = $this->context->controller->getCategory() + ->getProducts($this->context->language->id, $page, $limit); + + $event['name'] = 'view_item_list'; + $event['data']['currency'] = $this->context->currency->iso_code; + $result = array(); + + if ($products > 0) + { + foreach ($products as $product) + { + $category = new Category($product['id_category_default'], $this->context->language->id); + + array_push($result, array( + 'item_name' => Tools::replaceAccentedChars($product['name']), + 'item_id' => $product['id_product'], + 'price' => ((double) $product['price']), + 'item_brand' => $product['manufacturer_name'] ?? null, + 'item_category' => $category->name, + 'item_variant' => $product['attributes_small'] ?? null, + 'quantity' => $product['quantity'] + )); + } + } + + $event['data']['items'] = $result; + } + + $variables = array( + 'tracksmart_container' => Configuration::get('TRACKSMART_ID'), + 'tracksmart_user' => $this->context->customer->id ?? null, + 'tracksmart_event' => $event['name'] ?? null, + 'tracksmart_data' => Tools::jsonDecode(Tools::jsonEncode($event['data'] ?? "{}")) + ); + + Media::addJsDef(array('tracksmart_frontcontroller' => + Context::getContext()->link->getModuleLink($this->name, 'ajax', array(), true))); + + $this->context->smarty->assign($variables); + return $this->display(__FILE__, 'views/templates/hook/header.tpl'); + } + +} diff --git a/views/js/front.js b/views/js/front.js new file mode 100644 index 0000000..66c72d1 --- /dev/null +++ b/views/js/front.js @@ -0,0 +1,82 @@ +prestashop.on('clickQuickView', function(params) +{ + if (typeof(params) !== 'undefined') + { + let id = params.dataset.idProduct; + let attribute = params.dataset.idProductAttribute; + let customization = params.dataset.idCustomization; + + $.ajax({ + type: 'POST', + url: tracksmart_frontcontroller, + + data: { + id: id, + attribute: attribute, + customization: customization + }, + + success: function(data) + { + trackSmart.process('view_item', { + 'currency': prestashop.currency.iso_code, + 'items': [ data ] + }); + }, + + error: function(err) + { + console.error(err); + } + }); + } +}); + +prestashop.on('updateCart', function(params) +{ + if (typeof(params) !== 'undefined') + { + let id = params.reason.idProduct; + let attribute = params.reason.idProductAttribute; + let customization = params.reason.idCustomization; + + let action = params.reason.linkAction; + + if (action === 'add-to-cart' || action === 'delete-from-cart') + { + $.ajax({ + type: 'POST', + url: tracksmart_frontcontroller, + + data: { + id: id, + attribute: attribute, + customization: customization + }, + + success: function(data) + { + if (action === 'add-to-cart') + { + trackSmart.process('add_to_cart', { + 'currency': prestashop.currency.iso_code, + 'items': [ data ] + }); + } + else if (action === 'delete-from-cart') + { + trackSmart.track('remove_from_cart', { + 'currency': prestashop.currency.iso_code, + 'items': [ data ] + }); + } + }, + + error: function(err) + { + console.error(err); + } + }); + } + } +}); diff --git a/views/js/sdk.js b/views/js/sdk.js new file mode 100644 index 0000000..822a1d5 --- /dev/null +++ b/views/js/sdk.js @@ -0,0 +1,97 @@ +function TrackSmart(container) +{ + this.container = container; + this.user = null; + + this.state = false; +} + +function TrackSmart(container, user) +{ + this.container = container; + this.user = user; + + this.state = false; +} + +TrackSmart.prototype.build = function() +{ + if (this.container === null) + { + throw 'Container can not be null!'; + } + + if (this.state) + { + throw 'Module is enabled'; + } + + (function (w, d, s, l, i, u) + { + w[l] = w[l] || []; + + if (u !== null) + { + w[l].push({ + 'gtm.start': new Date().getTime(), event: 'sdk.js', user_id: u + }); + } + else + { + w[l].push({ + 'gtm.start': new Date().getTime(), event: 'sdk.js' + }); + } + + let f = d.getElementsByTagName(s)[0], + j = d.createElement(s), + dl = l != "dataLayer" ? "&l=" + l : ""; + j.async = true; + j.src = "https://www.googletagmanager.com/gtm.js?id=" + i + dl; + f.parentNode.insertBefore(j, f); + })(window, document, "script", "dataLayer", this.container, this.user ?? null); + + this.state = true; +} + +TrackSmart.prototype.process = function(event, ecommerce = {}) +{ + if (!event || !ecommerce) + { + throw 'Params can not be null'; + } + + if (!this.state || typeof dataLayer === 'undefined') + { + throw 'DataLayer can not be null'; + } + + let body = { + 'event': event, + 'ecommerce': ecommerce + } + + try + { + dataLayer.push(body); + } + catch (ex) + { + throw ex; + } +} + +TrackSmart.prototype.destroy = function() +{ + if (!this.state) + { + throw 'Module is disabled' + } + + if (typeof dataLayer !== 'undefined') + { + delete dataLayer; + } + + this.state = false; +} diff --git a/views/templates/admin/configure.tpl b/views/templates/admin/configure.tpl new file mode 100644 index 0000000..538a7f5 --- /dev/null +++ b/views/templates/admin/configure.tpl @@ -0,0 +1,9 @@ +
+

TrackSmart

+

+ Thank you for choosing a module
+ If you encounter a problem using the module, you can contact to me via form on site of module.
+ + Kacper Duras +

+
diff --git a/views/templates/hook/header.tpl b/views/templates/hook/header.tpl new file mode 100644 index 0000000..0001ece --- /dev/null +++ b/views/templates/hook/header.tpl @@ -0,0 +1,19 @@ +