changeset 87c7e1148534 in modules/marketing_automation:default
details:
https://hg.tryton.org/modules/marketing_automation?cmd=changeset;node=87c7e1148534
description:
Initial commit
issue7929
review45751002
diffstat:
.drone.yml | 51 +
COPYRIGHT | 16 +
INSTALL | 31 +
LICENSE | 674 +++++++++++++++++++++++++
MANIFEST.in | 6 +
README | 35 +
__init__.py | 33 +
doc/index.rst | 88 +++
empty.gif | Bin
exceptions.py | 16 +
marketing_automation.py | 853 ++++++++++++++++++++++++++++++++
marketing_automation.xml | 338 ++++++++++++
message.xml | 25 +
mixin.py | 6 +
party.py | 9 +
routes.py | 37 +
sale.py | 9 +
setup.py | 123 ++++
tests/__init__.py | 9 +
tests/email.html | 20 +
tests/reminder.html | 10 +
tests/scenario_marketing_automation.rst | 207 +++++++
tests/test_marketing_automation.py | 27 +
tox.ini | 15 +
tryton.cfg | 13 +
unsubscribe.html | 16 +
view/activity_form.xml | 42 +
view/activity_timedelta_form.xml | 21 +
view/activity_timedelta_list.xml | 12 +
view/activity_tree.xml | 12 +
view/record_activity_form.xml | 17 +
view/record_activity_list.xml | 12 +
view/record_form.xml | 11 +
view/record_list.xml | 8 +
view/scenario_form.xml | 22 +
view/scenario_list.xml | 10 +
web.py | 21 +
37 files changed, 2855 insertions(+), 0 deletions(-)
diffs (3001 lines):
diff -r 000000000000 -r 87c7e1148534 .drone.yml
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/.drone.yml Sat Mar 30 17:36:08 2019 +0100
@@ -0,0 +1,51 @@
+clone:
+ hg:
+ image: plugins/hg
+
+pipeline:
+ tox:
+ image: ${IMAGE}
+ environment:
+ - CFLAGS=-O0
+ - DB_CACHE=/cache
+ - TOX_TESTENV_PASSENV=CFLAGS DB_CACHE
+ - POSTGRESQL_URI=postgresql://postgres@postgresql:5432/
+ commands:
+ - pip install tox
+ - tox -e "${TOXENV}-${DATABASE}"
+ volumes:
+ - cache:/root/.cache
+
+services:
+ postgresql:
+ image: postgres
+ when:
+ matrix:
+ DATABASE: postgresql
+
+matrix:
+ include:
+ - IMAGE: python:3.4
+ TOXENV: py34
+ DATABASE: sqlite
+ - IMAGE: python:3.4
+ TOXENV: py34
+ DATABASE: postgresql
+ - IMAGE: python:3.5
+ TOXENV: py35
+ DATABASE: sqlite
+ - IMAGE: python:3.5
+ TOXENV: py35
+ DATABASE: postgresql
+ - IMAGE: python:3.6
+ TOXENV: py36
+ DATABASE: sqlite
+ - IMAGE: python:3.6
+ TOXENV: py36
+ DATABASE: postgresql
+ - IMAGE: python:3.7
+ TOXENV: py37
+ DATABASE: sqlite
+ - IMAGE: python:3.7
+ TOXENV: py37
+ DATABASE: postgresql
diff -r 000000000000 -r 87c7e1148534 COPYRIGHT
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/COPYRIGHT Sat Mar 30 17:36:08 2019 +0100
@@ -0,0 +1,16 @@
+Copyright (C) 2018-2019 B2CK
+Copyright (C) 2018-2019 Cédric Krier
+Copyright (C) 2018-2019 Nicolas Êvrard
+
+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 3 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, see <http://www.gnu.org/licenses/>.
diff -r 000000000000 -r 87c7e1148534 INSTALL
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/INSTALL Sat Mar 30 17:36:08 2019 +0100
@@ -0,0 +1,31 @@
+Installing trytond_marketing_automation
+=======================================
+
+Prerequisites
+-------------
+
+ * Python 3.4 or later (http://www.python.org/)
+ * trytond (http://www.tryton.org/)
+ * trytond_marketing (http://www.tryton.org/)
+ * trytond_web_shortener (http://www.tryton.org/)
+
+Installation
+------------
+
+Once you've downloaded and unpacked the trytond_marketing_automation source
+release, enter the directory where the archive was unpacked, and run:
+
+ python setup.py install
+
+Note that you may need administrator/root privileges for this step, as
+this command will by default attempt to install module to the Python
+site-packages directory on your system.
+
+For advanced options, please refer to the easy_install and/or the distutils
+documentation:
+
+ http://setuptools.readthedocs.io/en/latest/easy_install.html
+ http://docs.python.org/inst/inst.html
+
+To use without installation, extract the archive into ``trytond/modules`` with
+the directory name marketing_automation.
diff -r 000000000000 -r 87c7e1148534 LICENSE
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/LICENSE Sat Mar 30 17:36:08 2019 +0100
@@ -0,0 +1,674 @@
+ GNU GENERAL PUBLIC LICENSE
+ Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ 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.
+
+ 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
+state 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 3 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, see <http://www.gnu.org/licenses/>.
+
+Also add information on how to contact you by electronic and paper mail.
+
+ If the program does terminal interaction, make it output a short
+notice like this when it starts in an interactive mode:
+
+ <program> Copyright (C) <year> <name of author>
+ This program 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, your program's commands
+might be different; for a GUI interface, you would use an "about box".
+
+ You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU GPL, see
+<http://www.gnu.org/licenses/>.
+
+ The GNU 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. But first, please read
+<http://www.gnu.org/philosophy/why-not-lgpl.html>.
diff -r 000000000000 -r 87c7e1148534 MANIFEST.in
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/MANIFEST.in Sat Mar 30 17:36:08 2019 +0100
@@ -0,0 +1,6 @@
+include INSTALL
+include README
+include COPYRIGHT
+include CHANGELOG
+include LICENSE
+include doc/*
diff -r 000000000000 -r 87c7e1148534 README
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/README Sat Mar 30 17:36:08 2019 +0100
@@ -0,0 +1,35 @@
+trytond_marketing_automation
+============================
+
+The marketing_automation module of the Tryton application platform.
+
+Installing
+----------
+
+See INSTALL
+
+Support
+-------
+
+If you encounter any problems with Tryton, please don't hesitate to ask
+questions on the Tryton bug tracker, mailing list, wiki or IRC channel:
+
+ http://bugs.tryton.org/
+ http://groups.tryton.org/
+ http://wiki.tryton.org/
+ irc://irc.freenode.net/tryton
+
+License
+-------
+
+See LICENSE
+
+Copyright
+---------
+
+See COPYRIGHT
+
+
+For more information please visit the Tryton web site:
+
+ http://www.tryton.org/
diff -r 000000000000 -r 87c7e1148534 __init__.py
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/__init__.py Sat Mar 30 17:36:08 2019 +0100
@@ -0,0 +1,33 @@
+# This file is part of Tryton. The COPYRIGHT file at the top level of
+# this repository contains the full copyright notices and license terms.
+
+from trytond.pool import Pool
+
+from . import marketing_automation
+from . import web
+from . import party
+from . import sale
+from . import routes
+
+__all__ = ['register', 'routes']
+
+
+def register():
+ Pool.register(
+ marketing_automation.Scenario,
+ marketing_automation.Activity,
+ marketing_automation.Record,
+ marketing_automation.RecordActivity,
+ web.ShortenedURL,
+ module='marketing_automation', type_='model')
+ Pool.register(
+ party.Party,
+ module='marketing_automation', type_='model',
+ depends=['party'])
+ Pool.register(
+ sale.Sale,
+ module='marketing_automation', type_='model',
+ depends=['sale'])
+ Pool.register(
+ marketing_automation.Unsubscribe,
+ module='marketing_automation', type_='report')
diff -r 000000000000 -r 87c7e1148534 doc/index.rst
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/index.rst Sat Mar 30 17:36:08 2019 +0100
@@ -0,0 +1,88 @@
+Marketing Automation Module
+###########################
+
+The marketing_automation module allows marketing actions to automated. It is
+based on scenarios and activities that are executed on selected records.
+
+Scenario
+********
+
+A scenario provides the entry point for records into an automated marketing
+campaign. Each record can only enter a scenario once. A scenario is defined by:
+
+ * Name
+ * Model: the type of record for the scenario (by default Party and Sale)
+ * Domain: used to filter records
+ * State:
+
+ * Draft
+ * Running
+ * Stopped
+
+A cron task runs periodically to find new records to apply the scenario to.
+
+Activity
+********
+
+The activities form a scenario. They define which action should be triggered
+and when it should happen. The activities are organized as a tree and defined
+by:
+
+ * Name
+ * Parent
+ * Children
+ * On: event from the parent that triggers the activity:
+
+ * E-Mail Opened
+ * E-Mail Not Opened
+ * E-Mail Clicked
+ * E-Mail Not Clicked
+
+ * Condition: that the record must match to execute the activity
+ * Delay: before the action is executed
+ * Action: list of available actions
+
+Actions
+-------
+
+Send E-Mail
+...........
+
+The activity send an e-mail to the party defined on the record.
+The E-mail is composed using an HTML `Genshi <https://genshi.edgewall.org/>`_
+template with `record` in the evaluation context.
+All `<a>` elements have their `href` replaced by a shortened version used to
+trigger children activities. If the `href` value is `unsubscribe`, it is
+replaced by the URL which allows the recipient to block their record for the
+scenario.
+A empty image is automatically added at the end of the `<body>` to track when
+emails are opened.
+
+Record
+******
+
+It stores a reference to the records included in each scenario. If the record
+is blocked, no activity will be triggered for the record.
+
+Record Activity
+***************
+
+It stores the state of a record for an activity of the scenario.
+
+A cron task runs periodically to execute any waiting record activity that is
+due.
+
+Configuration
+*************
+
+The marketing_automation modules uses parameters from the section:
+
+- `[email]`:
+
+ - `from`: The default `From` for the email.
+
+- `[marketing]`:
+
+ - `automation_base`: The base URL without a path for the unsubscribe URL
+ and the empty image.
+ The default value is created using the configuration `[web]` `hostname`.
diff -r 000000000000 -r 87c7e1148534 empty.gif
Binary file empty.gif has changed
diff -r 000000000000 -r 87c7e1148534 exceptions.py
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/exceptions.py Sat Mar 30 17:36:08 2019 +0100
@@ -0,0 +1,16 @@
+# This file is part of Tryton. The COPYRIGHT file at the top level of
+# this repository contains the full copyright notices and license terms.
+
+from trytond.model.exceptions import ValidationError
+
+
+class DomainError(ValidationError):
+ pass
+
+
+class ConditionError(ValidationError):
+ pass
+
+
+class TemplateError(ValidationError):
+ pass
diff -r 000000000000 -r 87c7e1148534 marketing_automation.py
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/marketing_automation.py Sat Mar 30 17:36:08 2019 +0100
@@ -0,0 +1,853 @@
+# This file is part of Tryton. The COPYRIGHT file at the top level of
+# this repository contains the full copyright notices and license terms.
+import datetime
+import time
+import uuid
+from email.header import Header
+from email.mime.multipart import MIMEMultipart
+from email.mime.text import MIMEText
+from email.utils import formataddr, getaddresses
+from urllib.parse import (
+ urlsplit, parse_qsl, urlencode, urlunsplit, quote, urljoin)
+
+try:
+ import html2text
+except ImportError:
+ html2text = None
+
+from sql import Literal
+from sql.aggregate import Count
+from sql.functions import Substring, Position
+from genshi.template import MarkupTemplate
+from genshi.core import START, END, QName, Attrs
+
+from trytond.config import config
+from trytond.i18n import gettext
+from trytond.model import (fields, ModelSQL, ModelView, Workflow, Unique,
+ EvalEnvironment, dualmethod)
+from trytond.pool import Pool
+from trytond.pyson import PYSONDecoder, Eval, If
+from trytond.report import Report
+from trytond.sendmail import sendmail_transactional, SMTPDataManager
+from trytond.tools import grouped_slice, reduce_ids
+from trytond.transaction import Transaction
+from trytond.url import HOSTNAME
+from trytond.wsgi import Base64Converter
+
+from .exceptions import DomainError, ConditionError, TemplateError
+from .mixin import MarketingAutomationMixin
+
+if not config.get(
+ 'html', 'plugins-marketing.automation.activity-email_template'):
+ config.set(
+ 'html', 'plugins-marketing.automation.activity-email_template',
+ 'fullpage')
+
+USE_SSL = bool(config.get('ssl', 'certificate'))
+URL_BASE = config.get('marketing', 'automation_base',
+ default=urlunsplit(
+ ('http' + ('s' if USE_SSL else ''), HOSTNAME, '', '', '')))
+URL_OPEN = urljoin(URL_BASE, '/m/empty.gif')
+
+
+def _formataddr(name, email):
+ if name:
+ name = str(Header(name, 'utf-8'))
+ return formataddr((name, email))
+
+
+class Scenario(Workflow, ModelSQL, ModelView):
+ "Marketing Scenario"
+ __name__ = 'marketing.automation.scenario'
+
+ name = fields.Char("Name")
+ model = fields.Selection('get_models', "Model", required=True)
+ domain = fields.Char(
+ "Domain", required=True,
+ help="A PYSON domain used to filter records valid for this scenario.")
+ activities = fields.One2Many(
+ 'marketing.automation.activity', 'parent', "Activities")
+ record_count = fields.Function(
+ fields.Integer("Records"), 'get_record_count')
+ record_count_blocked = fields.Function(
+ fields.Integer("Records Blocked"), 'get_record_count')
+ state = fields.Selection([
+ ('draft', "Draft"),
+ ('running', "Running"),
+ ('stopped', "Stopped"),
+ ], "State", required=True, readonly=True)
+
+ @classmethod
+ def __setup__(cls):
+ super().__setup__()
+ cls._transitions |= set((
+ ('draft', 'running'),
+ ('running', 'stopped'),
+ ('stopped', 'draft'),
+ ))
+ cls._buttons.update(
+ draft={
+ 'invisible': Eval('state') != 'stopped',
+ 'depends': ['state'],
+ },
+ run={
+ 'invisible': Eval('state') != 'draft',
+ 'depends': ['state'],
+ },
+ stop={
+ 'invisible': Eval('state') != 'running',
+ },
+ )
+
+ @classmethod
+ def default_state(cls):
+ return 'draft'
+
+ @classmethod
+ def default_domain(cls):
+ return '[]'
+
+ @classmethod
+ def get_models(cls):
+ pool = Pool()
+ Model = pool.get('ir.model')
+
+ models = [name for name, klass in pool.iterobject()
+ if issubclass(klass, MarketingAutomationMixin)]
+ models = Model.search([
+ ('model', 'in', models),
+ ])
+ return [(m.model, m.name) for m in models]
+
+ @classmethod
+ def get_record_count(cls, scenarios, names):
+ pool = Pool()
+ Record = pool.get('marketing.automation.record')
+ record = Record.__table__()
+ cursor = Transaction().connection.cursor()
+
+ drafts = []
+ others = []
+ for scenario in scenarios:
+ if scenario.state == 'draft':
+ drafts.append(scenario)
+ else:
+ others.append(scenario)
+
+ count = {name: dict.fromkeys(map(int, scenarios), 0) for name in names}
+ for sub in grouped_slice(others):
+ cursor.execute(*record.select(
+ record.scenario,
+ Count(Literal('*')),
+ Count(Literal('*'), filter_=record.blocked),
+ where=reduce_ids(record.scenario, sub),
+ group_by=record.scenario))
+ for id_, all_, blocked in cursor:
+ if 'record_count' in count:
+ count['record_count'][id_] = all_
+ if 'record_count_blocked' in count:
+ count['record_count_blocked'][id_] = blocked
+ for scenario in drafts:
+ Model = pool.get(scenario.model)
+ domain = PYSONDecoder({}).decode(scenario.domain)
+ count['record_count'][scenario.id] = Model.search(
+ domain, count=True)
+ return count
+
+ @classmethod
+ def validate(cls, scenarios):
+ super().validate(scenarios)
+ cls.check_domain(scenarios)
+
+ @classmethod
+ def check_domain(cls, scenarios):
+ for scenario in scenarios:
+ try:
+ value = PYSONDecoder({}).decode(scenario.domain)
+ fields.domain_validate(value)
+ except Exception as exception:
+ raise DomainError(
+ gettext('marketing_automation.msg_scenario_invalid_domain',
+ scenario=scenario.rec_name,
+ exception=exception)) from exception
+
+ @classmethod
+ @ModelView.button
+ @Workflow.transition('draft')
+ def draft(cls, scenarios):
+ pass
+
+ @classmethod
+ @ModelView.button
+ @Workflow.transition('running')
+ def run(cls, scenarios):
+ pass
+
+ @classmethod
+ @ModelView.button
+ @Workflow.transition('stopped')
+ def stop(cls, scenarios):
+ pass
+
+ @classmethod
+ def trigger(cls, scenarios=None):
+ pool = Pool()
+ Record = pool.get('marketing.automation.record')
+ RecordActivity = pool.get('marketing.automation.record.activity')
+
+ if scenarios is None:
+ scenarios = cls.search([
+ ('state', '=', 'running'),
+ ])
+
+ for scenario in scenarios:
+ Model = pool.get(scenario.model)
+ sql_int = scenario.__class__.id.sql_type().base
+ record = Record.__table__()
+ cursor = Transaction().connection.cursor()
+ domain = PYSONDecoder({}).decode(scenario.domain)
+ cursor.execute(*(
+ Model.search(domain, query=True, order=[])
+ - record.select(
+ Substring(
+ record.record,
+ Position(',', record.record) + Literal(1)
+ ).cast(sql_int),
+ where=record.scenario == scenario.id)))
+
+ records = []
+ for id_, in cursor.fetchall():
+ records.append(
+ Record(scenario=scenario, record=Model(id_)))
+
+ if not records:
+ continue
+ Record.save(records)
+ record_activities = []
+ for record in records:
+ for activity in scenario.activities:
+ if (activity.condition
+ and not record.match(activity.condition)):
+ continue
+ record_activities.append(
+ RecordActivity.get(record, activity))
+ RecordActivity.save(record_activities)
+
+
+class Activity(ModelSQL, ModelView):
+ "Marketing Activity"
+ __name__ = 'marketing.automation.activity'
+
+ name = fields.Char("Name", required=True)
+ parent = fields.Reference(
+ "Parent", [
+ ('marketing.automation.scenario', "Scenario"),
+ ('marketing.automation.activity', "Activity"),
+ ],
+ required=True)
+ children = fields.One2Many(
+ 'marketing.automation.activity', 'parent', "Children")
+ parent_action = fields.Function(
+ fields.Selection('get_parent_actions', "Parent Action"),
+ 'on_change_with_parent_action')
+
+ event = fields.Selection([
+ (None, ""),
+ ('email_opened', "E-Mail Opened"),
+ ('email_clicked', "E-Mail Clicked"),
+ ], "Event") # domain set by _parent_action_events
+ negative = fields.Boolean("Negative",
+ states={
+ 'invisible': ~Eval('event'),
+ },
+ depends=['event'],
+ help="Check to execute the activity "
+ "if the event has not happened by the end of the delay.")
+ on = fields.Function(fields.Selection([
+ (None, ""),
+ ('email_opened', "E-Mail Opened"),
+ ('email_opened_not', "E-Mail Not Opened"),
+ ('email_clicked', "E-Mail Clicked"),
+ ('email_clicked_not', "E-Mail Not Clicked"),
+ ], "On"), # domain set by _parent_action_events
+ 'get_on', setter='set_on')
+ condition = fields.Char("Condition",
+ help="The PYSON statement that the record must match "
+ "in order to execute the activity.\n"
+ 'The record is represented by "self"')
+
+ delay = fields.TimeDelta(
+ "Delay",
+ states={
+ 'required': Eval('negative', False),
+ },
+ depends=['negative'],
+ help="After how much time the action should be executed.")
+
+ action = fields.Selection([
+ (None, ''),
+ ('send_email', "Send E-Mail"),
+ ], "Action")
+
+ # Send E-mail
+ email_from = fields.Char("From",
+ states={
+ 'invisible': Eval('action') != 'send_email',
+ },
+ depends=['action'],
+ help="Leave empty to use the value defined in the configuration file.")
+ email_title = fields.Char(
+ "E-Mail Title",
+ translate=True,
+ states={
+ 'invisible': Eval('action') != 'send_email',
+ 'required': Eval('action') == 'send_email',
+ },
+ depends=['action'])
+ email_template = fields.Text(
+ "E-Mail Template",
+ translate=True,
+ states={
+ 'invisible': Eval('action') != 'send_email',
+ 'required': Eval('action') == 'send_email',
+ },
+ depends=['action'],
+ help="The HTML content of the E-mail.\n"
+ "The Genshi syntax can be used "
+ "with 'record' in the evaluation context.")
+
+ record_count = fields.Function(
+ fields.Integer("Records"), 'get_record_count')
+ email_opened = fields.Function(
+ fields.Integer(
+ "E-Mails Opened",
+ states={
+ 'invisible': Eval('action') != 'send_email',
+ },
+ depends=['action']), 'get_record_count')
+ email_clicked = fields.Function(
+ fields.Integer(
+ "E-Mails Clicked",
+ states={
+ 'invisible': Eval('action') != 'send_email',
+ },
+ depends=['action']), 'get_record_count')
+
+ @classmethod
+ def __setup__(cls):
+ super().__setup__()
+ for name in ['event', 'on']:
+ field = getattr(cls, name)
+ domain = [(name, '=', None)]
+ for parent_action, events in cls._parent_action_events().items():
+ if name == 'on':
+ events += [e + '_not' for e in events]
+ domain = If(Eval('parent_action') == parent_action,
+ [(name, 'in', events + [None])],
+ domain)
+ field.domain = [domain]
+ field.depends = ['parent_action']
+
+ @classmethod
+ def view_attributes(cls):
+ return [
+ ('//group[@id="email"]', 'states', {
+ 'invisible': Eval('action') != 'send_email',
+ }),
+ ]
+
+ @classmethod
+ def get_parent_actions(cls):
+ return cls.fields_get(['action'])['action']['selection']
+
+ @fields.depends('parent')
+ def on_change_with_parent_action(self, name=None):
+ if isinstance(self.parent, self.__class__):
+ return self.parent.action
+ return None
+
+ @classmethod
+ def _parent_action_events(cls):
+ "Return dictionary to pair parent action and valid events"
+ return {
+ 'send_email': ['email_opened', 'email_clicked'],
+ }
+
+ def get_on(self, name):
+ value = self.event
+ if self.negative and value:
+ value += '_not'
+ return value
+
+ @fields.depends('on', 'event', 'negative')
+ def on_change_on(self):
+ if not self.on:
+ self.negative = False
+ self.event = None
+ else:
+ self.negative = self.on.endswith('_not')
+ self.event = self.on[:-len('_not')] if self.negative else self.on
+
+ @classmethod
+ def set_on(cls, activities, name, value):
+ if not value:
+ negative = False
+ event = None
+ else:
+ negative = value.endswith('_not')
+ event = value[:-len('_not')] if negative else value
+ cls.write(activities, {
+ 'event': event,
+ 'negative': negative,
+ })
+
+ @classmethod
+ def get_record_count(cls, activities, names):
+ pool = Pool()
+ RecordActivity = pool.get('marketing.automation.record.activity')
+ record_activity = RecordActivity.__table__()
+ cursor = Transaction().connection.cursor()
+
+ count = {name: dict.fromkeys(map(int, activities), 0)
+ for name in names}
+ for sub in grouped_slice(activities):
+ cursor.execute(*record_activity.select(
+ record_activity.activity,
+ Count(Literal('*'),
+ filter_=record_activity.state == 'done'),
+ Count(Literal('*'), filter_=record_activity.email_opened),
+ Count(Literal('*'), filter_=record_activity.email_clicked),
+ where=reduce_ids(record_activity.activity, sub),
+ group_by=record_activity.activity))
+ for id_, all_, email_opened, email_clicked in cursor:
+ if 'record_count' in count:
+ count['record_count'][id_] = all_
+ if 'email_opened' in count:
+ count['email_opened'][id_] = email_opened
+ if 'email_clicked' in count:
+ count['email_clicked'][id_] = email_clicked
+ return count
+
+ @classmethod
+ def validate(cls, activities):
+ super().validate(activities)
+ for activity in activities:
+ activity.check_condition()
+ activity.check_email_template()
+
+ def check_condition(self):
+ if not self.condition:
+ return
+ try:
+ PYSONDecoder(noeval=True).decode(self.condition)
+ except Exception as exception:
+ raise ConditionError(
+ gettext('marketing_automation.msg_activity_invalid_condition',
+ condition=self.condition,
+ activity=self.rec_name,
+ exception=exception)) from exception
+
+ def check_email_template(self):
+ if not self.email_template:
+ return
+ try:
+ MarkupTemplate(self.email_template)
+ except Exception as exception:
+ raise TemplateError(
+ gettext('marketing_automation'
+ '.msg_activity_invalid_email_template',
+ activity=self.rec_name,
+ exception=exception)) from exception
+
+ def execute(self, activity, **kwargs):
+ pool = Pool()
+ RecordActivity = pool.get('marketing.automation.record.activity')
+ record = activity.record
+
+ # XXX: use domain
+ if self.condition and not record.eval(self.condition):
+ return
+
+ if self.action:
+ getattr(self, 'execute_' + self.action)(activity, **kwargs)
+ RecordActivity.save([
+ RecordActivity.get(record, child)
+ for child in self.children])
+
+ def _email_recipient(self, record):
+ pool = Pool()
+ try:
+ Party = pool.get('party.party')
+ except KeyError:
+ Party = None
+ try:
+ Sale = pool.get('sale.sale')
+ except KeyError:
+ Sale = None
+
+ def get_party_email(party):
+ contact = party.contact_mechanism_get('email')
+ if contact and contact.email:
+ return _formataddr(
+ contact.name or party.rec_name,
+ contact.email)
+ return None
+
+ if Party and isinstance(record, Party):
+ return get_party_email(record)
+ elif Sale and isinstance(record, Sale):
+ return get_party_email(record.party)
+
+ def execute_send_email(
+ self, record_activity, smtpd_datamanager=None, **kwargs):
+ pool = Pool()
+ WebShortener = pool.get('web.shortened_url')
+ record = record_activity.record
+
+ with Transaction().set_context(language=record.language):
+ record = record.__class__(record.id)
+ translated = self.__class__(self.id)
+
+ to = self._email_recipient(record.record)
+ if not to:
+ return
+
+ def unsubscribe(redirect):
+ parts = urlsplit(urljoin(
+ URL_BASE, quote(b'/m/%(database)s/unsubscribe' % {
+ b'database': Base64Converter(None).to_url(
+ Transaction().database.name),
+ })))
+ query = parse_qsl(parts.query)
+ query.append(('r', record.uuid))
+ if redirect:
+ query.append(('next', redirect))
+ parts = list(parts)
+ parts[3] = urlencode(query)
+ return urlunsplit(parts)
+
+ def short(url, event):
+ url = WebShortener(
+ record=record_activity,
+ method='marketing.automation.record.activity|%s' % event,
+ redirect_url=url)
+ url.save()
+ return url.shortened_url
+
+ def convert_href(stream):
+ for kind, data, pos in stream:
+ if kind is START:
+ tag, attrs = data
+ if tag == 'a':
+ href = attrs.get('href')
+ attrs -= 'href'
+ if href.startswith('unsubscribe'):
+ href = unsubscribe(href[len('unsubscribe|'):])
+ else:
+ href = short(href, 'on_email_clicked')
+ attrs |= [(QName('href'), href)]
+ data = tag, attrs
+ elif kind is END and data == 'body':
+ yield START, (QName('img'), Attrs([
+ (QName('src'), short(
+ URL_OPEN, 'on_email_opened')),
+ (QName('height'), '1'),
+ (QName('width'), '1'),
+ ])), pos
+ yield END, QName('img'), pos
+ yield kind, data, pos
+
+ template = MarkupTemplate(translated.email_template)
+ content = (template
+ .generate(record=record.record)
+ .filter(convert_href)
+ .render())
+
+ msg = MIMEMultipart('alternative')
+ msg['From'] = self.email_from or config.get('email', 'from')
+ msg['To'] = to
+ msg['Subject'] = Header(translated.email_title, 'utf-8')
+ if html2text:
+ converter = html2text.HTML2Text()
+ part = MIMEText(
+ converter.handle(content), 'plain', _charset='utf-8')
+ msg.attach(part)
+ part = MIMEText(content, 'html', _charset='utf-8')
+ msg.attach(part)
+
+ to_addrs = [a for _, a in getaddresses([to])]
+ if to_addrs:
+ sendmail_transactional(
+ self.email_from, to_addrs, msg, datamanager=smtpd_datamanager)
+
+
+class Record(ModelSQL, ModelView):
+ "Marketing Record"
+ __name__ = 'marketing.automation.record'
+
+ scenario = fields.Many2One(
+ 'marketing.automation.scenario', "Scenario",
+ required=True, ondelete='CASCADE')
+ record = fields.Reference(
+ "Record", selection='get_models', required=True)
+ blocked = fields.Boolean("Blocked")
+ uuid = fields.Char("UUID", readonly=True)
+
+ @classmethod
+ def __setup__(cls):
+ super().__setup__()
+
+ t = cls.__table__()
+ cls._sql_constraints = [
+ ('scenario_record_unique', Unique(t, t.scenario, t.record),
+ 'marketing_automation.msg_record_scenario_unique'),
+ ('uuid_unique', Unique(t, t.uuid),
+ 'marketing_automation.msg_record_uuid_unique'),
+ ]
+
+ @classmethod
+ def default_uuid(cls):
+ return uuid.uuid4().hex
+
+ @classmethod
+ def default_blocked(cls):
+ return False
+
+ @fields.depends('scenario')
+ def get_models(self):
+ pool = Pool()
+ Model = pool.get('ir.model')
+
+ if not self.scenario:
+ return [('', '')]
+
+ model, = Model.search([
+ ('model', '=', self.scenario.model),
+ ])
+ return [(model.model, model.name)]
+
+ def eval(self, expression):
+ env = {}
+ env['current_date'] = datetime.datetime.today()
+ env['time'] = time
+ env['context'] = Transaction().context
+ env['self'] = EvalEnvironment(self.record, self.record.__class__)
+ return PYSONDecoder(env).decode(expression)
+
+ @property
+ def language(self):
+ pool = Pool()
+ try:
+ Party = pool.get('party.party')
+ except KeyError:
+ Party = None
+ try:
+ Sale = pool.get('sale.sale')
+ except KeyError:
+ Sale = None
+
+ if Party and isinstance(self.record, Party):
+ if self.record.lang:
+ return self.record.lang.code
+ elif Sale and isinstance(self.record, Sale):
+ if self.record.party.lang:
+ return self.record.party.lang.code
+
+ @dualmethod
+ def block(cls, records):
+ cls.write(records, {'blocked': True})
+
+ def get_rec_name(self, name):
+ return self.record.rec_name
+
+ @classmethod
+ def create(cls, vlist):
+ vlist = [v.copy() for v in vlist]
+ for values in vlist:
+ # Ensure to get a different uuid for each record
+ # default methods are called only once
+ values.setdefault('uuid', cls.default_uuid())
+ return super().create(vlist)
+
+
+class RecordActivity(Workflow, ModelSQL, ModelView):
+ "Marketing Record Activity"
+ __name__ = 'marketing.automation.record.activity'
+
+ record = fields.Many2One(
+ 'marketing.automation.record', "Record",
+ required=True, ondelete='CASCADE')
+ activity = fields.Many2One(
+ 'marketing.automation.activity', "Activity",
+ required=True, ondelete='CASCADE')
+ activity_action = fields.Function(
+ fields.Selection('get_activity_actions', "Activity Action"),
+ 'on_change_with_activity_action')
+ at = fields.DateTime(
+ "At",
+ states={
+ 'readonly': Eval('state') != 'waiting',
+ },
+ depends=['state'])
+ email_opened = fields.Boolean(
+ "E-Mail Opened",
+ states={
+ 'invisible': Eval('activity_action') != 'send_email',
+ },
+ depends=['activity_action'])
+ email_clicked = fields.Boolean(
+ "E-Mail Clicked",
+ states={
+ 'invisible': Eval('activity_action') != 'send_email',
+ },
+ depends=['activity_action'])
+ state = fields.Selection([
+ ('waiting', "Waiting"),
+ ('done', "Done"),
+ ('cancelled', "Cancelled"),
+ ], "State", required=True, readonly=True)
+
+ @classmethod
+ def __setup__(cls):
+ super().__setup__()
+ t = cls.__table__()
+ cls._sql_constraints = [
+ ('activity_record_unique', Unique(t, t.activity, t.record),
+ 'marketing_automation.msg_activity_record_unique'),
+ ]
+ cls._transitions |= set((
+ ('waiting', 'done'),
+ ('waiting', 'cancelled'),
+ ))
+ cls._buttons.update(
+ on_email_opened={
+ 'invisible': ((Eval('state') != 'waiting')
+ | (Eval('activity_action') != 'send_email')
+ | Eval('email_opened', False)),
+ 'depends': ['state', 'activity_action', 'email_opened'],
+ },
+ on_email_clicked={
+ 'invisible': ((Eval('state') != 'waiting')
+ | (Eval('activity_action') != 'send_email')
+ | Eval('email_clicked', False)),
+ 'depends': ['state', 'activity_action', 'email_clicked'],
+ },
+ )
+
+ @classmethod
+ def default_email_opened(cls):
+ return False
+
+ @classmethod
+ def default_email_clicked(cls):
+ return False
+
+ @classmethod
+ def default_state(cls):
+ return 'waiting'
+
+ @classmethod
+ def get_activity_actions(cls):
+ pool = Pool()
+ Activity = pool.get('marketing.automation.activity')
+ return Activity.fields_get(['action'])['action']['selection']
+
+ @fields.depends('activity')
+ def on_change_with_activity_action(self, name=None):
+ if self.activity:
+ return self.activity.action
+
+ @classmethod
+ def get(cls, record, activity):
+ record_activity = cls(activity=activity, record=record)
+ if activity.negative or not activity.event:
+ record_activity.set_delay()
+ return record_activity
+
+ def set_delay(self):
+ now = datetime.datetime.now()
+ self.at = now
+ if self.activity.delay is not None:
+ self.at += self.activity.delay
+
+ @classmethod
+ def process(cls):
+ now = datetime.datetime.now()
+ activities = cls.search([
+ ('state', '=', 'waiting'),
+ ('at', '<=', now),
+ ('record.blocked', '!=', True),
+ ])
+ cls.do(activities)
+
+ @classmethod
+ @ModelView.button
+ def on_email_opened(cls, record_activities):
+ for record_activity in record_activities:
+ record_activity._on_event('email_opened')
+ cls.save(record_activities)
+
+ @classmethod
+ @ModelView.button
+ def on_email_clicked(cls, record_activities):
+ for record_activity in record_activities:
+ record_activity._on_event('email_clicked')
+ cls.save(record_activities)
+
+ def _on_event(self, event):
+ cls = self.__class__
+ record_activities = cls.search([
+ ('record', '=', str(self.record)),
+ ('activity', 'in', [
+ c.id for c in self.activity.children
+ if c.event == event and not c.negative]),
+ ('state', '=', 'waiting'),
+ ])
+ cls._cancel_opposite(record_activities)
+ for record_activity in record_activities:
+ record_activity.set_delay()
+ cls.save(record_activities)
+ setattr(self, event, True)
+
+ @classmethod
+ def _cancel_opposite(cls, record_activities):
+ to_cancel = set()
+ for record_activity in record_activities:
+ records = cls.search([
+ ('record', '=', record_activity.record),
+ ('state', '=', 'waiting'),
+ ('activity.parent',
+ '=', str(record_activity.activity.parent)),
+ ('activity.event', '=', record_activity.activity.event),
+ ('activity.negative',
+ '=', not record_activity.activity.negative),
+ ])
+ to_cancel.update(records)
+ cls.cancel(to_cancel)
+
+ @classmethod
+ @Workflow.transition('done')
+ def do(cls, record_activities, **kwargs):
+ cls._cancel_opposite(record_activities)
+
+ now = datetime.datetime.now()
+ for record_activity in record_activities:
+ record_activity.activity.execute(
+ record_activity, smtpd_datamanager=SMTPDataManager(), **kwargs)
+ record_activity.at = now
+ record_activity.state = 'done'
+ cls.save(record_activities)
+
+ @classmethod
+ @Workflow.transition('cancelled')
+ def cancel(cls, record_activities):
+ now = datetime.datetime.now()
+ cls.write(record_activities, {
+ 'at': now,
+ 'state': 'cancelled',
+ })
+
+
+class Unsubscribe(Report):
+ "Marketing Automation Unsubscribe"
+ __name__ = 'marketing.automation.unsubscribe'
diff -r 000000000000 -r 87c7e1148534 marketing_automation.xml
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/marketing_automation.xml Sat Mar 30 17:36:08 2019 +0100
@@ -0,0 +1,338 @@
+<?xml version="1.0"?>
+<!-- This file is part of Tryton. The COPYRIGHT file at the top level of
+this repository contains the full copyright notices and license terms. -->
+<tryton>
+ <data>
+
+ <record model="ir.ui.view" id="scenario_view_list">
+ <field name="model">marketing.automation.scenario</field>
+ <field name="type">tree</field>
+ <field name="name">scenario_list</field>
+ </record>
+
+ <record model="ir.ui.view" id="scenario_view_form">
+ <field name="model">marketing.automation.scenario</field>
+ <field name="type">form</field>
+ <field name="name">scenario_form</field>
+ </record>
+
+ <record model="ir.action.act_window" id="act_scenario_form">
+ <field name="name">Scenarios</field>
+ <field name="res_model">marketing.automation.scenario</field>
+ </record>
+ <record model="ir.action.act_window.view" id="act_scenario_form_view1">
+ <field name="sequence" eval="10"/>
+ <field name="view" ref="scenario_view_list"/>
+ <field name="act_window" ref="act_scenario_form"/>
+ </record>
+ <record model="ir.action.act_window.view" id="act_scenario_form_view2">
+ <field name="sequence" eval="20"/>
+ <field name="view" ref="scenario_view_form"/>
+ <field name="act_window" ref="act_scenario_form"/>
+ </record>
+ <record model="ir.action.act_window.domain"
id="act_scenario_form_domain_draft">
+ <field name="name">Draft</field>
+ <field name="sequence" eval="10"/>
+ <field name="domain" eval="[('state', '=', 'draft')]" pyson="1"/>
+ <field name="count" eval="True"/>
+ <field name="act_window" ref="act_scenario_form"/>
+ </record>
+ <record model="ir.action.act_window.domain"
id="act_scenario_form_domain_running">
+ <field name="name">Running</field>
+ <field name="sequence" eval="20"/>
+ <field name="domain" eval="[('state', '=', 'running')]" pyson="1"/>
+ <field name="count" eval="True"/>
+ <field name="act_window" ref="act_scenario_form"/>
+ </record>
+ <record model="ir.action.act_window.domain"
id="act_scenario_form_domain_stopped">
+ <field name="name">Stopped</field>
+ <field name="sequence" eval="30"/>
+ <field name="domain" eval="[('state', '=', 'stopped')]" pyson="1"/>
+ <field name="act_window" ref="act_scenario_form"/>
+ </record>
+ <record model="ir.action.act_window.domain"
id="act_scenario_form_domain_all">
+ <field name="name">All</field>
+ <field name="sequence" eval="9999"/>
+ <field name="act_window" ref="act_scenario_form"/>
+ </record>
+
+ <menuitem parent="marketing.menu_marketing" action="act_scenario_form"
id="menu_scenario_form"/>
+
+ <record model="ir.model.access" id="access_scenario">
+ <field name="model" search="[('model', '=',
'marketing.automation.scenario')]"/>
+ <field name="perm_read" eval="False"/>
+ <field name="perm_write" eval="False"/>
+ <field name="perm_create" eval="False"/>
+ <field name="perm_delete" eval="False"/>
+ </record>
+ <record model="ir.model.access" id="access_scenario_marketing">
+ <field name="model" search="[('model', '=',
'marketing.automation.scenario')]"/>
+ <field name="group" ref="marketing.group_marketing"/>
+ <field name="perm_read" eval="True"/>
+ <field name="perm_write" eval="True"/>
+ <field name="perm_create" eval="True"/>
+ <field name="perm_delete" eval="True"/>
+ </record>
+
+ <record model="ir.model.button" id="scenario_draft_button">
+ <field name="name">draft</field>
+ <field name="string">Draft</field>
+ <field name="model" search="[('model', '=',
'marketing.automation.scenario')]"/>
+ </record>
+ <record model="ir.model.button" id="scenario_run_button">
+ <field name="name">run</field>
+ <field name="string">Run</field>
+ <field name="model" search="[('model', '=',
'marketing.automation.scenario')]"/>
+ </record>
+ <record model="ir.model.button" id="scenario_stop_button">
+ <field name="name">stop</field>
+ <field name="string">Stop</field>
+ <field name="model" search="[('model', '=',
'marketing.automation.scenario')]"/>
+ </record>
+
+ <record model="ir.ui.view" id="activity_view_list">
+ <field name="model">marketing.automation.activity</field>
+ <field name="type">tree</field>
+ <field name="priority" eval="10"/>
+ <field name="name">activity_tree</field>
+ </record>
+ <record model="ir.ui.view" id="activity_view_tree">
+ <field name="model">marketing.automation.activity</field>
+ <field name="type">tree</field>
+ <field name="field_childs">children</field>
+ <field name="priority" eval="20"/>
+ <field name="name">activity_tree</field>
+ </record>
+
+ <record model="ir.ui.view" id="activity_view_form">
+ <field name="model">marketing.automation.activity</field>
+ <field name="type">form</field>
+ <field name="name">activity_form</field>
+ </record>
+
+ <record model="ir.action.act_window" id="act_activity_tree">
+ <field name="name">Activities</field>
+ <field name="res_model">marketing.automation.activity</field>
+ <field name="domain" eval="[('parent', '=', (Eval('active_model'),
Eval('active_id')))]" pyson="1"/>
+ </record>
+ <record model="ir.action.act_window.view" id="act_activity_tree_view1">
+ <field name="sequence" eval="10"/>
+ <field name="view" ref="activity_view_tree"/>
+ <field name="act_window" ref="act_activity_tree"/>
+ </record>
+ <record model="ir.action.act_window.view" id="act_activity_tree_view2">
+ <field name="sequence" eval="20"/>
+ <field name="view" ref="activity_view_form"/>
+ <field name="act_window" ref="act_activity_tree"/>
+ </record>
+ <record model="ir.action.keyword" id="act_activity_tree_keyword1">
+ <field name="keyword">form_relate</field>
+ <field name="model">marketing.automation.scenario,-1</field>
+ <field name="action" ref="act_activity_tree"/>
+ </record>
+ <record model="ir.action.keyword" id="act_activity_tree_keyword2">
+ <field name="keyword">tree_open</field>
+ <field name="model">marketing.automation.scenario,-1</field>
+ <field name="action" ref="act_activity_tree"/>
+ </record>
+
+ <record model="ir.model.access" id="access_activity">
+ <field name="model" search="[('model', '=',
'marketing.automation.activity')]"/>
+ <field name="perm_read" eval="False"/>
+ <field name="perm_write" eval="False"/>
+ <field name="perm_create" eval="False"/>
+ <field name="perm_delete" eval="False"/>
+ </record>
+ <record model="ir.model.access" id="access_activity_marketing">
+ <field name="model" search="[('model', '=',
'marketing.automation.activity')]"/>
+ <field name="group" ref="marketing.group_marketing"/>
+ <field name="perm_read" eval="True"/>
+ <field name="perm_write" eval="True"/>
+ <field name="perm_create" eval="True"/>
+ <field name="perm_delete" eval="True"/>
+ </record>
+
+ <record model="ir.ui.view" id="record_view_list">
+ <field name="model">marketing.automation.record</field>
+ <field name="type">tree</field>
+ <field name="name">record_list</field>
+ </record>
+
+ <record model="ir.ui.view" id="record_view_form">
+ <field name="model">marketing.automation.record</field>
+ <field name="type">form</field>
+ <field name="name">record_form</field>
+ </record>
+
+ <record model="ir.action.act_window" id="act_record_form">
+ <field name="name">Records</field>
+ <field name="res_model">marketing.automation.record</field>
+ <field name="domain" eval="[If(Eval('active_ids', []) ==
[Eval('active_id')], ('scenario', '=', Eval('active_id')), ('scenario', 'in',
Eval('active_ids')))]" pyson="1"/>
+ </record>
+ <record model="ir.action.act_window.view" id="act_record_form_view1">
+ <field name="sequence" eval="10"/>
+ <field name="view" ref="record_view_list"/>
+ <field name="act_window" ref="act_record_form"/>
+ </record>
+ <record model="ir.action.act_window.view" id="act_record_form_view2">
+ <field name="sequence" eval="20"/>
+ <field name="view" ref="record_view_form"/>
+ <field name="act_window" ref="act_record_form"/>
+ </record>
+ <record model="ir.action.keyword" id="act_record_form_keyword1">
+ <field name="keyword">form_relate</field>
+ <field name="model">marketing.automation.scenario,-1</field>
+ <field name="action" ref="act_record_form"/>
+ </record>
+
+ <record model="ir.model.access" id="access_record">
+ <field name="model" search="[('model', '=',
'marketing.automation.record')]"/>
+ <field name="perm_read" eval="False"/>
+ <field name="perm_write" eval="False"/>
+ <field name="perm_create" eval="False"/>
+ <field name="perm_delete" eval="False"/>
+ </record>
+ <record model="ir.model.access" id="access_record_marketing">
+ <field name="model" search="[('model', '=',
'marketing.automation.record')]"/>
+ <field name="group" ref="marketing.group_marketing"/>
+ <field name="perm_read" eval="True"/>
+ <field name="perm_write" eval="True"/>
+ <field name="perm_create" eval="True"/>
+ <field name="perm_delete" eval="True"/>
+ </record>
+
+ <record model="ir.ui.view" id="record_activity_view_list">
+ <field name="model">marketing.automation.record.activity</field>
+ <field name="type">tree</field>
+ <field name="name">record_activity_list</field>
+ </record>
+
+ <record model="ir.ui.view" id="record_activity_view_form">
+ <field name="model">marketing.automation.record.activity</field>
+ <field name="type">form</field>
+ <field name="name">record_activity_form</field>
+ </record>
+
+ <record model="ir.action.act_window" id="act_record_activity_form">
+ <field name="name">Record Activities</field>
+ <field
name="res_model">marketing.automation.record.activity</field>
+ <field name="domain" eval="[If(Eval('active_ids', []) ==
[Eval('active_id')], (If(Eval('active_model') == 'marketing.automation.record',
'record', 'activity'), '=', Eval('active_id')), (If(Eval('active_model') ==
'marketing.automation.record', 'record', 'activity'), 'in',
Eval('active_ids')))]" pyson="1"/>
+ </record>
+ <record model="ir.action.act_window.view"
id="act_record_activity_form_view1">
+ <field name="sequence" eval="10"/>
+ <field name="view" ref="record_activity_view_list"/>
+ <field name="act_window" ref="act_record_activity_form"/>
+ </record>
+ <record model="ir.action.act_window.view"
id="act_record_activity_form_view2">
+ <field name="sequence" eval="20"/>
+ <field name="view" ref="record_activity_view_form"/>
+ <field name="act_window" ref="act_record_activity_form"/>
+ </record>
+ <record model="ir.action.act_window.domain"
id="act_record_activity_form_domain_waiting">
+ <field name="name">Waiting</field>
+ <field name="sequence" eval="10"/>
+ <field name="domain" eval="[('state', '=', 'waiting')]" pyson="1"/>
+ <field name="count" eval="True"/>
+ <field name="act_window" ref="act_record_activity_form"/>
+ </record>
+ <record model="ir.action.act_window.domain"
id="act_record_activity_form_domain_done">
+ <field name="name">Done</field>
+ <field name="sequence" eval="20"/>
+ <field name="domain" eval="[('state', '=', 'done')]" pyson="1"/>
+ <field name="act_window" ref="act_record_activity_form"/>
+ </record>
+ <record model="ir.action.act_window.domain"
id="act_record_activity_form_domain_cancelled">
+ <field name="name">Cancelled</field>
+ <field name="sequence" eval="30"/>
+ <field name="domain" eval="[('state', '=', 'cancelled')]"
pyson="1"/>
+ <field name="act_window" ref="act_record_activity_form"/>
+ </record>
+ <record model="ir.action.act_window.domain"
id="act_record_activity_form_domain_all">
+ <field name="name">All</field>
+ <field name="sequence" eval="9999"/>
+ <field name="act_window" ref="act_record_activity_form"/>
+ </record>
+
+ <record model="ir.action.keyword"
id="act_record_activity_form_keyword1">
+ <field name="keyword">form_relate</field>
+ <field name="model">marketing.automation.record,-1</field>
+ <field name="action" ref="act_record_activity_form"/>
+ </record>
+ <record model="ir.action.keyword"
id="act_record_activity_form_keyword2">
+ <field name="keyword">form_relate</field>
+ <field name="model">marketing.automation.activity,-1</field>
+ <field name="action" ref="act_record_activity_form"/>
+ </record>
+
+ <record model="ir.model.access" id="access_record_activity">
+ <field name="model" search="[('model', '=',
'marketing.automation.record.activity')]"/>
+ <field name="perm_read" eval="False"/>
+ <field name="perm_write" eval="False"/>
+ <field name="perm_create" eval="False"/>
+ <field name="perm_delete" eval="False"/>
+ </record>
+ <record model="ir.model.access" id="access_record_activity_marketing">
+ <field name="model" search="[('model', '=',
'marketing.automation.record.activity')]"/>
+ <field name="group" ref="marketing.group_marketing"/>
+ <field name="perm_read" eval="True"/>
+ <field name="perm_write" eval="True"/>
+ <field name="perm_create" eval="True"/>
+ <field name="perm_delete" eval="True"/>
+ </record>
+
+ <record model="ir.model.button"
id="record_activity_on_email_opened_button">
+ <field name="name">on_email_opened</field>
+ <field name="string">E-Mail Opened</field>
+ <field name="model" search="[('model', '=',
'marketing.automation.record.activity')]"/>
+ </record>
+ <record model="ir.model.button"
id="record_activity_on_email_clicked_button">
+ <field name="name">on_email_clicked</field>
+ <field name="string">E-Mail Clicked</field>
+ <field name="model" search="[('model', '=',
'marketing.automation.record.activity')]"/>
+ </record>
+
+ <record model="ir.action.report" id="report_unsubscribe">
+ <field name="name">Marketing Automation Unsubscribe</field>
+ <field name="model"></field>
+ <field name="report_name">marketing.automation.unsubscribe</field>
+ <field name="report">unsubscribe.html</field>
+ <field name="template_extension">html</field>
+ </record>
+
+ <record model="res.user" id="user_marketing_automation">
+ <field name="login">user_marketing_automation</field>
+ <field name="name">Cron Marketing Automation</field>
+ <field name="active" eval="False"/>
+ </record>
+ <record model="res.user-res.group"
id="user_marketing_automation_group_marketing_automation">
+ <field name="user" ref="user_marketing_automation"/>
+ <field name="group" ref="marketing.group_marketing"/>
+ </record>
+
+ <record model="ir.cron" id="cron_scenario_trigger">
+ <field name="name">Trigger Scenarios</field>
+ <field name="request_user" ref="res.user_admin"/>
+ <field name="user" ref="user_marketing_automation"/>
+ <field name="active" eval="True"/>
+ <field name="interval_number" eval="1"/>
+ <field name="interval_type">hours</field>
+ <field name="number_calls" eval="-1"/>
+ <field name="repeat_missed" eval="False"/>
+ <field name="model">marketing.automation.scenario</field>
+ <field name="function">trigger</field>
+ </record>
+ <record model="ir.cron" id="cron_record_activity_process">
+ <field name="name">Process Record Activity</field>
+ <field name="request_user" ref="res.user_admin"/>
+ <field name="user" ref="user_marketing_automation"/>
+ <field name="active" eval="True"/>
+ <field name="interval_number" eval="15"/>
+ <field name="interval_type">minutes</field>
+ <field name="number_calls" eval="-1"/>
+ <field name="repeat_missed" eval="False"/>
+ <field name="model">marketing.automation.record.activity</field>
+ <field name="function">process</field>
+ </record>
+
+ </data>
+</tryton>
diff -r 000000000000 -r 87c7e1148534 message.xml
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/message.xml Sat Mar 30 17:36:08 2019 +0100
@@ -0,0 +1,25 @@
+<?xml version="1.0"?>
+<!-- This file is part of Tryton. The COPYRIGHT file at the top level of
+this repository contains the full copyright notices and license terms. -->
+<tryton>
+ <data group="1">
+ <record model="ir.message" id="msg_scenario_invalid_domain">
+ <field name="text">Invalid domain in scenario "%(scenario)s" with
exception "%(exception)s".</field>
+ </record>
+ <record model="ir.message" id="msg_activity_invalid_condition">
+ <field name="text">Invalid condition "%(condition)s" in activity
"%(activity)s" with exception "%(exception)s".</field>
+ </record>
+ <record model="ir.message" id="msg_activity_invalid_email_template">
+ <field name="text">Invalid e-mail template in activity
"%(activity)s" with exception "%(exception)s".</field>
+ </record>
+ <record model="ir.message" id="msg_activity_record_unique">
+ <field name="text">Record Activity must be unique by record and
activity.</field>
+ </record>
+ <record model="ir.message" id="msg_record_scenario_record_unique">
+ <field name="text">Record must be unique by scenario.</field>
+ </record>
+ <record model="ir.message" id="msg_record_uuid_unique">
+ <field name="text">UUID of record must be unique.</field>
+ </record>
+ </data>
+</tryton>
diff -r 000000000000 -r 87c7e1148534 mixin.py
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/mixin.py Sat Mar 30 17:36:08 2019 +0100
@@ -0,0 +1,6 @@
+# This file is part of Tryton. The COPYRIGHT file at the top level of
+# this repository contains the full copyright notices and license terms.
+
+
+class MarketingAutomationMixin:
+ pass
diff -r 000000000000 -r 87c7e1148534 party.py
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/party.py Sat Mar 30 17:36:08 2019 +0100
@@ -0,0 +1,9 @@
+# This file is part of Tryton. The COPYRIGHT file at the top level of
+# this repository contains the full copyright notices and license terms.
+
+from trytond.pool import PoolMeta
+from .mixin import MarketingAutomationMixin
+
+
+class Party(MarketingAutomationMixin, metaclass=PoolMeta):
+ __name__ = 'party.party'
diff -r 000000000000 -r 87c7e1148534 routes.py
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/routes.py Sat Mar 30 17:36:08 2019 +0100
@@ -0,0 +1,37 @@
+# This file is part of Tryton. The COPYRIGHT file at the top level of
+# this repository contains the full copyright notices and license terms.
+from werkzeug.wrappers import Response
+from werkzeug.utils import redirect
+
+from trytond.transaction import Transaction
+from trytond.tools import file_open
+from trytond.protocols.wrappers import with_pool, with_transaction
+from trytond.wsgi import app
+
+
[email protected]('/m/<base64:database_name>$unsubscribe')
+@with_pool
+@with_transaction(readonly=False)
+def unsubscribe(request, pool):
+ Record = pool.get('marketing.automation.record')
+ Report = pool.get('marketing.automation.unsubscribe', type='report')
+ record, = Record.search([
+ ('uuid', '=', request.args['r']),
+ ])
+ record.block()
+ next_ = request.args.get('next')
+ if next_:
+ redirect(next_)
+ data = {
+ 'model': Record.__name__,
+ }
+ with Transaction().set_context(language=record.language):
+ ext, content, _, _ = Report.execute([record], data)
+ assert ext == 'html'
+ return Response(content, 200, content_type='text/html')
+
+
[email protected]('/m/empty.gif')
+def empty(request):
+ fp = file_open('marketing_automation/empty.gif', mode='rb')
+ return Response(fp, 200, content_type='image/gif', direct_passthrough=True)
diff -r 000000000000 -r 87c7e1148534 sale.py
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/sale.py Sat Mar 30 17:36:08 2019 +0100
@@ -0,0 +1,9 @@
+# This file is part of Tryton. The COPYRIGHT file at the top level of
+# this repository contains the full copyright notices and license terms.
+
+from trytond.pool import PoolMeta
+from .mixin import MarketingAutomationMixin
+
+
+class Sale(MarketingAutomationMixin, metaclass=PoolMeta):
+ __name__ = 'sale.sale'
diff -r 000000000000 -r 87c7e1148534 setup.py
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/setup.py Sat Mar 30 17:36:08 2019 +0100
@@ -0,0 +1,123 @@
+#!/usr/bin/env python3
+# This file is part of Tryton. The COPYRIGHT file at the top level of
+# this repository contains the full copyright notices and license terms.
+
+import io
+import os
+import re
+from configparser import ConfigParser
+from setuptools import setup, find_packages
+
+
+def read(fname):
+ return io.open(
+ os.path.join(os.path.dirname(__file__), fname),
+ 'r', encoding='utf-8').read()
+
+
+def get_require_version(name):
+ if minor_version % 2:
+ require = '%s >= %s.%s.dev0, < %s.%s'
+ else:
+ require = '%s >= %s.%s, < %s.%s'
+ require %= (name, major_version, minor_version,
+ major_version, minor_version + 1)
+ return require
+
+
+config = ConfigParser()
+config.read_file(open('tryton.cfg'))
+info = dict(config.items('tryton'))
+for key in ('depends', 'extras_depend', 'xml'):
+ if key in info:
+ info[key] = info[key].strip().splitlines()
+version = info.get('version', '0.0.1')
+major_version, minor_version, _ = version.split('.', 2)
+major_version = int(major_version)
+minor_version = int(minor_version)
+name = 'trytond_marketing_automation'
+
+download_url = 'http://downloads.tryton.org/%s.%s/' % (
+ major_version, minor_version)
+if minor_version % 2:
+ version = '%s.%s.dev0' % (major_version, minor_version)
+ download_url = (
+ 'hg+http://hg.tryton.org/modules/%s#egg=%s-%s' % (
+ name[8:], name, version))
+
+requires = []
+for dep in info.get('depends', []):
+ if not re.match(r'(ir|res)(\W|$)', dep):
+ requires.append(get_require_version('trytond_%s' % dep))
+requires.append(get_require_version('trytond'))
+
+tests_require = []
+dependency_links = []
+if minor_version % 2:
+ dependency_links.append('https://trydevpi.tryton.org/')
+
+setup(name=name,
+ version=version,
+ description='Tryton module to plan, coordinate and manage marketing
campaigns',
+ long_description=read('README'),
+ author='Tryton',
+ author_email='[email protected]',
+ url='http://www.tryton.org/',
+ download_url=download_url,
+ keywords='tryton marketing automation',
+ package_dir={'trytond.modules.marketing_automation': '.'},
+ packages=(
+ ['trytond.modules.marketing_automation'] +
+ ['trytond.modules.marketing_automation.%s' % p for p in
find_packages()]
+ ),
+ package_data={
+ 'trytond.modules.marketing_automation': (info.get('xml', [])
+ + ['tryton.cfg', 'view/*.xml', 'locale/*.po', '*.fodt',
+ 'icons/*.svg', 'tests/*.rst', '*.html', '*.gif']),
+ },
+ classifiers=[
+ 'Development Status :: 5 - Production/Stable',
+ 'Environment :: Plugins',
+ 'Framework :: Tryton',
+ 'Intended Audience :: Developers',
+ 'Intended Audience :: Financial and Insurance Industry',
+ 'Intended Audience :: Legal Industry',
+ 'License :: OSI Approved :: GNU General Public License v3 or later
(GPLv3+)',
+ 'Natural Language :: Bulgarian',
+ 'Natural Language :: Catalan',
+ 'Natural Language :: Chinese (Simplified)',
+ 'Natural Language :: Czech',
+ 'Natural Language :: Dutch',
+ 'Natural Language :: English',
+ 'Natural Language :: French',
+ 'Natural Language :: German',
+ 'Natural Language :: Hungarian',
+ 'Natural Language :: Italian',
+ 'Natural Language :: Persian',
+ 'Natural Language :: Polish',
+ 'Natural Language :: Portuguese (Brazilian)',
+ 'Natural Language :: Russian',
+ 'Natural Language :: Slovenian',
+ 'Natural Language :: Spanish',
+ 'Operating System :: OS Independent',
+ 'Programming Language :: Python :: 3.4',
+ 'Programming Language :: Python :: 3.5',
+ 'Programming Language :: Python :: 3.6',
+ 'Programming Language :: Python :: 3.7',
+ 'Programming Language :: Python :: Implementation :: CPython',
+ 'Programming Language :: Python :: Implementation :: PyPy',
+ 'Topic :: Office/Business',
+ ],
+ license='GPL-3',
+ python_requires='>=3.4',
+ install_requires=requires,
+ dependency_links=dependency_links,
+ zip_safe=False,
+ entry_points="""
+ [trytond.modules]
+ marketing_automation = trytond.modules.marketing_automation
+ """,
+ test_suite='tests',
+ test_loader='trytond.test_loader:Loader',
+ tests_require=tests_require,
+ )
diff -r 000000000000 -r 87c7e1148534 tests/__init__.py
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/tests/__init__.py Sat Mar 30 17:36:08 2019 +0100
@@ -0,0 +1,9 @@
+# This file is part of Tryton. The COPYRIGHT file at the top level of
+# this repository contains the full copyright notices and license terms.
+
+try:
+ from trytond.modules.marketing_automation.tests.test_marketing_automation
import suite
+except ImportError:
+ from .test_marketing_automation import suite
+
+__all__ = ['suite']
diff -r 000000000000 -r 87c7e1148534 tests/email.html
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/tests/email.html Sat Mar 30 17:36:08 2019 +0100
@@ -0,0 +1,20 @@
+<!DOCTYPE html>
+<html xmlns:py="http://genshi.edgewall.org/";>
+ <head>
+ <title>Hello!</title>
+ </head>
+ <body>
+ <p>Hello, ${record.name}!</p>
+ <p>
+ Here is a
+ <a href="http://example.com/action";>
+ nice link
+ </a>.
+ </p>
+ <p>
+ <a href="unsubscribe|http://example.com/unsubscribe";>
+ Unsubscribe
+ </a>
+ </p>
+ </body>
+</html>
diff -r 000000000000 -r 87c7e1148534 tests/reminder.html
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/tests/reminder.html Sat Mar 30 17:36:08 2019 +0100
@@ -0,0 +1,10 @@
+<!DOCTYPE html>
+<html xmlns:py="http://genshi.edgewall.org/";>
+ <head>
+ <title>Missing you!</title>
+ </head>
+ <body>
+ <p>Hello, ${record.name}!</p>
+ <p>We miss you!</p>
+ </body>
+</html>
diff -r 000000000000 -r 87c7e1148534 tests/scenario_marketing_automation.rst
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/tests/scenario_marketing_automation.rst Sat Mar 30 17:36:08 2019 +0100
@@ -0,0 +1,207 @@
+Marketing Automation Scenario
+=============================
+
+Imports::
+
+ >>> import datetime
+ >>> import re
+ >>> from proteus import Model, Wizard
+ >>> from proteus.config import get_config
+ >>> from trytond.tests.tools import activate_modules
+ >>> from trytond.tools import file_open
+
+Patch sendmail_transactional::
+
+ >>> from unittest.mock import MagicMock
+ >>> from trytond.modules.marketing_automation import marketing_automation
+ >>> marketing_automation.sendmail_transactional = smtp_calls = MagicMock()
+
+Install marketing_automation::
+
+ >>> config = activate_modules(['marketing_automation', 'party'])
+
+Create a party::
+
+ >>> Party = Model.get('party.party')
+ >>> party = Party()
+ >>> party.name = "Michael Scott"
+ >>> contact = party.contact_mechanisms.new()
+ >>> contact.type = 'email'
+ >>> contact.value = '[email protected]'
+ >>> party.save()
+
+Create the running scenario::
+
+ >>> Scenario = Model.get('marketing.automation.scenario')
+ >>> Activity = Model.get('marketing.automation.activity')
+ >>> scenario = Scenario()
+ >>> scenario.name = "Party Scenario"
+ >>> scenario.model = 'party.party'
+ >>> scenario.domain = '[["contact_mechanisms", "!=", null]]'
+ >>> scenario.save()
+
+ >>> root_activity = Activity()
+ >>> root_activity.name = "First E-Mail"
+ >>> root_activity.parent = scenario
+ >>> root_activity.action = 'send_email'
+ >>> root_activity.email_title = "Hello"
+ >>> with file_open('marketing_automation/tests/email.html', mode='r') as
fp:
+ ... root_activity.email_template = fp.read()
+ >>> root_activity.save()
+
+ >>> email_opened = Activity()
+ >>> email_opened.name = "E-Mail Opened"
+ >>> email_opened.parent = root_activity
+ >>> email_opened.on = 'email_opened'
+ >>> email_opened.save()
+
+ >>> email_clicked = Activity()
+ >>> email_clicked.name = "E-Mail Clicked"
+ >>> email_clicked.parent = root_activity
+ >>> email_clicked.on = 'email_clicked'
+ >>> email_clicked.save()
+
+ >>> email_not_clicked = Activity()
+ >>> email_not_clicked.name = "E-Mail no clicked"
+ >>> email_not_clicked.parent = root_activity
+ >>> email_not_clicked.on = 'email_clicked_not'
+ >>> email_not_clicked.delay = datetime.timedelta(days=2)
+ >>> email_not_clicked.save()
+
+ >>> email_reminder = Activity()
+ >>> email_reminder.name = "E-Mail Reminder"
+ >>> email_reminder.parent = root_activity
+ >>> email_reminder.action = 'send_email'
+ >>> email_reminder.email_title = "Reminder"
+ >>> email_reminder.delay = datetime.timedelta()
+ >>> with file_open('marketing_automation/tests/reminder.html', mode='r')
as fp:
+ ... email_reminder.email_template = fp.read()
+ >>> email_reminder.save()
+
+ >>> scenario.record_count
+ 1
+
+ >>> scenario.click('run')
+
+Trigger scenario::
+
+ >>> Cron = Model.get('ir.cron')
+ >>> cron_trigger, = Cron.find([
+ ... ('model', '=', 'marketing.automation.scenario'),
+ ... ('function', '=', 'trigger'),
+ ... ])
+ >>> cron_process, = Cron.find([
+ ... ('model', '=', 'marketing.automation.record.activity'),
+ ... ('function', '=', 'process'),
+ ... ])
+ >>> cron_trigger.click('run_once')
+ >>> cron_process.click('run_once')
+
+ >>> Record = Model.get('marketing.automation.record')
+ >>> record, = Record.find([])
+ >>> record.record == party
+ True
+ >>> scenario.record_count
+ 1
+ >>> scenario.record_count_blocked
+ 0
+
+Check email sent::
+
+ >>> ShortenedURL = Model.get('web.shortened_url')
+ >>> open_url, = ShortenedURL.find([
+ ... ('redirect_url', 'like', '%/m/empty.gif'),
+ ... ])
+ >>> click_url, = ShortenedURL.find([
+ ... ('redirect_url', '=', 'http://example.com/action'),
+ ... ])
+
+ >>> RecordActivity = Model.get('marketing.automation.record.activity')
+ >>> record_activity, = RecordActivity.find([
+ ... ('record', '=', record.id),
+ ... ('activity', '=', root_activity.id),
+ ... ])
+ >>> record_activity.state
+ 'done'
+ >>> root_activity.reload()
+ >>> root_activity.record_count
+ 1
+
+ >>> smtp_calls.call_count
+ 1
+ >>> from_, to, msg = smtp_calls.call_args[0]
+ >>> smtp_calls.reset_mock()
+ >>> msg = msg.get_payload(1).get_payload(decode=True).decode('utf-8')
+ >>> to == [contact.value]
+ True
+ >>> re.search(r'Hello, (.*)!', msg).group(1) == party.name
+ True
+ >>> open_url.shortened_url in msg
+ True
+ >>> open_url.record == record_activity
+ True
+ >>> open_url.method
+ 'marketing.automation.record.activity|on_email_opened'
+ >>> click_url.shortened_url in msg
+ True
+ >>> click_url.record == record_activity
+ True
+ >>> click_url.method
+ 'marketing.automation.record.activity|on_email_clicked'
+ >>> record.uuid in msg
+ True
+
+Trigger open email and reminder after delay::
+
+ >>> record_activity.click('on_email_opened')
+
+ >>> open_activity, = RecordActivity.find([
+ ... ('record', '=', record.id),
+ ... ('activity', '=', email_opened.id),
+ ... ])
+ >>> bool(open_activity.at)
+ True
+ >>> open_activity.state
+ 'waiting'
+
+ >>> cron_process.click('run_once')
+
+ >>> open_activity.reload()
+ >>> open_activity.state
+ 'done'
+ >>> root_activity.reload()
+ >>> root_activity.email_opened
+ 1
+
+ >>> email_reminder, = RecordActivity.find([
+ ... ('record', '=', record.id),
+ ... ('activity', '=', email_reminder.id),
+ ... ])
+ >>> email_reminder.state
+ 'done'
+
+ >>> smtp_calls.call_count
+ 1
+ >>> smtp_calls.reset_mock()
+
+Trigger click email::
+
+ >>> record_activity.click('on_email_clicked')
+ >>> cron_process.click('run_once')
+
+ >>> clicked_activity, = RecordActivity.find([
+ ... ('record', '=', record.id),
+ ... ('activity', '=', email_clicked.id),
+ ... ])
+ >>> clicked_activity.state
+ 'done'
+ >>> root_activity.reload()
+ >>> root_activity.email_clicked
+ 1
+
+ >>> not_clicked_activity, = RecordActivity.find([
+ ... ('record', '=', record.id),
+ ... ('activity', '=', email_not_clicked.id),
+ ... ])
+ >>> not_clicked_activity.state
+ 'cancelled'
diff -r 000000000000 -r 87c7e1148534 tests/test_marketing_automation.py
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/tests/test_marketing_automation.py Sat Mar 30 17:36:08 2019 +0100
@@ -0,0 +1,27 @@
+# This file is part of Tryton. The COPYRIGHT file at the top level of
+# this repository contains the full copyright notices and license terms.
+
+import unittest
+import doctest
+
+from trytond.tests.test_tryton import ModuleTestCase
+from trytond.tests.test_tryton import suite as test_suite
+from trytond.tests.test_tryton import doctest_teardown
+from trytond.tests.test_tryton import doctest_checker
+
+
+class MarketingAutomationTestCase(ModuleTestCase):
+ 'Test Marketing Automation module'
+ module = 'marketing_automation'
+
+
+def suite():
+ suite = test_suite()
+ suite.addTests(unittest.TestLoader().loadTestsFromTestCase(
+ MarketingAutomationTestCase))
+ suite.addTests(doctest.DocFileSuite(
+ 'scenario_marketing_automation.rst',
+ tearDown=doctest_teardown, encoding='utf-8',
+ checker=doctest_checker,
+ optionflags=doctest.REPORT_ONLY_FIRST_FAILURE))
+ return suite
diff -r 000000000000 -r 87c7e1148534 tox.ini
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/tox.ini Sat Mar 30 17:36:08 2019 +0100
@@ -0,0 +1,15 @@
+[tox]
+envlist = {py34,py35,py36,py37}-{sqlite,postgresql},pypy3-{sqlite,postgresql}
+
+[testenv]
+commands = {envpython} setup.py test
+deps =
+ {py34,py35,py36,py37}-postgresql: psycopg2 >= 2.5
+ pypy3-postgresql: psycopg2cffi >= 2.5
+ {py34,py35,py36}-sqlite: sqlitebck
+setenv =
+ sqlite: TRYTOND_DATABASE_URI={env:SQLITE_URI:sqlite://}
+ postgresql: TRYTOND_DATABASE_URI={env:POSTGRESQL_URI:postgresql://}
+ sqlite: DB_NAME={env:SQLITE_NAME::memory:}
+ postgresql: DB_NAME={env:POSTGRESQL_NAME:test}
+install_command = pip install --pre --find-links https://trydevpi.tryton.org/
{opts} {packages}
diff -r 000000000000 -r 87c7e1148534 tryton.cfg
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/tryton.cfg Sat Mar 30 17:36:08 2019 +0100
@@ -0,0 +1,13 @@
+[tryton]
+version=5.1.0
+depends:
+ ir
+ res
+ marketing
+ web_shortener
+extras_depend:
+ sale
+ party
+xml:
+ marketing_automation.xml
+ message.xml
diff -r 000000000000 -r 87c7e1148534 unsubscribe.html
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/unsubscribe.html Sat Mar 30 17:36:08 2019 +0100
@@ -0,0 +1,16 @@
+<!DOCTYPE html>
+<html xmlns:py="http://genshi.edgewall.org/";>
+ <head>
+ <meta charset="utf-8"/>
+ <title>Unsubscribe</title>
+ </head>
+ <body>
+ <py:for each="record in records">
+ <div style="display: block; text-align: center">
+ <h1>You are unsubscribed</h1>
+ <p><strong>You have been successfully unsubscribed from this kind
of email.</strong></p>
+ <p>We are sorry to see you go, and apologize if we have
overwhelmed your inbox.</p>
+ </div>
+ </py:for>
+ </body>
+</html>
diff -r 000000000000 -r 87c7e1148534 view/activity_form.xml
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/view/activity_form.xml Sat Mar 30 17:36:08 2019 +0100
@@ -0,0 +1,42 @@
+<?xml version="1.0"?>
+<!-- This file is part of Tryton. The COPYRIGHT file at the top level of
+this repository contains the full copyright notices and license terms. -->
+<form>
+ <label name="name"/>
+ <field name="name"/>
+ <label name="parent"/>
+ <field name="parent"/>
+
+ <label name="action"/>
+ <field name="action"/>
+ <newline/>
+
+ <label name="on" string="On"/>
+ <field name="on"/>
+ <label name="delay" string="After"/>
+ <field name="delay"/>
+
+ <label name="condition" string="If"/>
+ <field name="condition" colspan="3" widget="pyson"/>
+
+ <notebook colspan="4">
+ <page name="action" col="1">
+ <group id="email" yexpand="1" yfill="1">
+ <label name="email_from"/>
+ <field name="email_from" colspan="3"/>
+
+ <label name="email_title" string="Title:"/>
+ <field name="email_title" colspan="3"/>
+
+ <label name="email_template" string="Template:" yfill="1"
yalign="0"/>
+ <group col="-1" id="email_template" colspan="3" yexpand="1">
+ <field name="email_template"/>
+ <field name="email_template" string="Edit" widget="html"
xexpand="0"/>
+ </group>
+ </group>
+ </page>
+ <page name="children">
+ <field name="children" colspan="4"/>
+ </page>
+ </notebook>
+</form>
diff -r 000000000000 -r 87c7e1148534 view/activity_timedelta_form.xml
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/view/activity_timedelta_form.xml Sat Mar 30 17:36:08 2019 +0100
@@ -0,0 +1,21 @@
+<?xml version="1.0"?>
+<!-- This file is part of Tryton. The COPYRIGHT file at the top level of
+this repository contains the full copyright notices and license terms. -->
+<form>
+ <label name="activity"/>
+ <field name="activity"/>
+ <label name="sequence"/>
+ <field name="sequence"/>
+ <label name="months"/>
+ <field name="months"/>
+ <label name="month"/>
+ <field name="month"/>
+ <label name="weeks"/>
+ <field name="weeks"/>
+ <label name="weekday"/>
+ <field name="weekday"/>
+ <label name="days"/>
+ <field name="days"/>
+ <label name="day"/>
+ <field name="day"/>
+</form>
diff -r 000000000000 -r 87c7e1148534 view/activity_timedelta_list.xml
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/view/activity_timedelta_list.xml Sat Mar 30 17:36:08 2019 +0100
@@ -0,0 +1,12 @@
+<?xml version="1.0"?>
+<!-- This file is part of Tryton. The COPYRIGHT file at the top level of
+this repository contains the full copyright notices and license terms. -->
+<tree>
+ <field name="activity"/>
+ <field name="day"/>
+ <field name="month"/>
+ <field name="weekday"/>
+ <field name="months"/>
+ <field name="weeks"/>
+ <field name="days"/>
+</tree>
diff -r 000000000000 -r 87c7e1148534 view/activity_tree.xml
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/view/activity_tree.xml Sat Mar 30 17:36:08 2019 +0100
@@ -0,0 +1,12 @@
+<?xml version="1.0"?>
+<!-- This file is part of Tryton. The COPYRIGHT file at the top level of
+this repository contains the full copyright notices and license terms. -->
+<tree>
+ <field name="name"/>
+ <field name="on"/>
+ <field name="delay"/>
+ <field name="action"/>
+ <field name="record_count"/>
+ <field name="email_opened"/>
+ <field name="email_clicked"/>
+</tree>
diff -r 000000000000 -r 87c7e1148534 view/record_activity_form.xml
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/view/record_activity_form.xml Sat Mar 30 17:36:08 2019 +0100
@@ -0,0 +1,17 @@
+<?xml version="1.0"?>
+<!-- This file is part of Tryton. The COPYRIGHT file at the top level of
+this repository contains the full copyright notices and license terms. -->
+<form>
+ <label name="record"/>
+ <field name="record"/>
+ <label name="activity"/>
+ <field name="activity"/>
+ <label name="at"/>
+ <field name="at"/>
+ <label name="state"/>
+ <field name="state"/>
+ <group col="-1" colspan="4" id="buttons">
+ <button name="on_email_opened"/>
+ <button name="on_email_clicked"/>
+ </group>
+</form>
diff -r 000000000000 -r 87c7e1148534 view/record_activity_list.xml
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/view/record_activity_list.xml Sat Mar 30 17:36:08 2019 +0100
@@ -0,0 +1,12 @@
+<?xml version="1.0"?>
+<!-- This file is part of Tryton. The COPYRIGHT file at the top level of
+this repository contains the full copyright notices and license terms. -->
+<tree>
+ <field name="record"/>
+ <field name="activity"/>
+ <field name="at" widget="date"/>
+ <field name="at" string="Time" widget="time"/>
+ <field name="email_opened"/>
+ <field name="email_clicked"/>
+ <field name="state"/>
+</tree>
diff -r 000000000000 -r 87c7e1148534 view/record_form.xml
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/view/record_form.xml Sat Mar 30 17:36:08 2019 +0100
@@ -0,0 +1,11 @@
+<?xml version="1.0"?>
+<!-- This file is part of Tryton. The COPYRIGHT file at the top level of
+this repository contains the full copyright notices and license terms. -->
+<form>
+ <label name="record"/>
+ <field name="record"/>
+ <label name="scenario"/>
+ <field name="scenario"/>
+ <label name="blocked"/>
+ <field name="blocked"/>
+</form>
diff -r 000000000000 -r 87c7e1148534 view/record_list.xml
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/view/record_list.xml Sat Mar 30 17:36:08 2019 +0100
@@ -0,0 +1,8 @@
+<?xml version="1.0"?>
+<!-- This file is part of Tryton. The COPYRIGHT file at the top level of
+this repository contains the full copyright notices and license terms. -->
+<tree>
+ <field name="scenario"/>
+ <field name="record"/>
+ <field name="blocked"/>
+</tree>
diff -r 000000000000 -r 87c7e1148534 view/scenario_form.xml
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/view/scenario_form.xml Sat Mar 30 17:36:08 2019 +0100
@@ -0,0 +1,22 @@
+<?xml version="1.0"?>
+<!-- This file is part of Tryton. The COPYRIGHT file at the top level of
+this repository contains the full copyright notices and license terms. -->
+<form>
+ <label name="name"/>
+ <field name="name" colspan="3"/>
+
+ <label name="model"/>
+ <field name="model"/>
+ <label name="domain"/>
+ <field name="domain" widget="pyson"/>
+
+ <field name="activities" colspan="4"
view_ids="marketing_automation.activity_view_list"/>
+
+ <label name="state"/>
+ <field name="state"/>
+ <group id="buttons" col="-1" colspan="2">
+ <button name="draft" icon="tryton-undo"/>
+ <button name="run" icon="tryton-forward"/>
+ <button name="stop" icon="tryton-cancel"/>
+ </group>
+</form>
diff -r 000000000000 -r 87c7e1148534 view/scenario_list.xml
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/view/scenario_list.xml Sat Mar 30 17:36:08 2019 +0100
@@ -0,0 +1,10 @@
+<?xml version="1.0"?>
+<!-- This file is part of Tryton. The COPYRIGHT file at the top level of
+this repository contains the full copyright notices and license terms. -->
+<tree keyword_open="1">
+ <field name="name"/>
+ <field name="model"/>
+ <field name="record_count"/>
+ <field name="record_count_blocked"/>
+ <field name="state"/>
+</tree>
diff -r 000000000000 -r 87c7e1148534 web.py
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/web.py Sat Mar 30 17:36:08 2019 +0100
@@ -0,0 +1,21 @@
+# This file is part of Tryton. The COPYRIGHT file at the top level of
+# this repository contains the full copyright notices and license terms.
+
+from trytond.pool import PoolMeta
+
+
+class ShortenedURL(metaclass=PoolMeta):
+ __name__ = 'web.shortened_url'
+
+ @classmethod
+ def _get_models(cls):
+ return super()._get_models() + [
+ 'marketing.automation.record.activity',
+ ]
+
+ @classmethod
+ def _get_methods(cls):
+ return super()._get_methods() + [
+ 'marketing.automation.record.activity|on_email_opened',
+ 'marketing.automation.record.activity|on_email_clicked',
+ ]
