changeset 846a274c92a4 in modules/marketing_email:default
details:
https://hg.tryton.org/modules/marketing_email?cmd=changeset;node=846a274c92a4
description:
Add marketing_email module
issue7835
review38711002
diffstat:
.drone.yml | 62 +++
.flake8 | 2 +
COPYRIGHT | 16 +
LICENSE | 674 ++++++++++++++++++++++++++++++++++++++++
MANIFEST.in | 5 +
README.rst | 1 +
__init__.py | 28 +
doc/index.rst | 59 +++
email_subscribe.html | 42 ++
email_unsubscribe.html | 42 ++
empty.gif | Bin
exceptions.py | 8 +
icons/tryton-marketing-mail.svg | 1 +
ir.py | 15 +
marketing.py | 533 +++++++++++++++++++++++++++++++
marketing.xml | 214 ++++++++++++
message.xml | 14 +
routes.py | 12 +
setup.py | 132 +++++++
tests/__init__.py | 9 +
tests/test_marketing_email.py | 165 +++++++++
tox.ini | 15 +
tryton.cfg | 12 +
view/email_form.xml | 11 +
view/email_list.xml | 9 +
view/email_list_form.xml | 14 +
view/email_list_list.xml | 7 +
view/email_message_form.xml | 30 +
view/email_message_list.xml | 9 +
view/send_test_form.xml | 9 +
web.py | 14 +
31 files changed, 2164 insertions(+), 0 deletions(-)
diffs (2288 lines):
diff -r 000000000000 -r 846a274c92a4 .drone.yml
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/.drone.yml Sat Sep 12 15:36:37 2020 +0200
@@ -0,0 +1,62 @@
+clone:
+ hg:
+ image: plugins/hg
+ environment:
+ - HG_SHARE_POOL=/root/.cache/hg
+ volumes:
+ - cache:/root/.cache
+
+pipeline:
+ tox:
+ image: ${IMAGE}
+ environment:
+ - CFLAGS=-O0
+ - DB_CACHE=/cache
+ - TOX_TESTENV_PASSENV=CFLAGS DB_CACHE
+ - POSTGRESQL_URI=postgresql://postgres@postgresql:5432/
+ commands:
+ - echo "[extensions]" >> /root/.hgrc
+ - echo "hgext.share =" >> /root/.hgrc
+ - echo "[share]" >> /root/.hgrc
+ - echo "pool = /root/.cache/hg" >> /root/.hgrc
+ - pip install tox
+ - tox -e "${TOXENV}-${DATABASE}"
+ volumes:
+ - cache:/root/.cache
+
+services:
+ postgresql:
+ image: postgres
+ environment:
+ - POSTGRES_HOST_AUTH_METHOD=trust
+ command: "-c fsync=off -c synchronous_commit=off -c
full_page_writes=off"
+ when:
+ matrix:
+ DATABASE: postgresql
+
+matrix:
+ include:
+ - 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
+ - IMAGE: python:3.8
+ TOXENV: py38
+ DATABASE: sqlite
+ - IMAGE: python:3.8
+ TOXENV: py38
+ DATABASE: postgresql
diff -r 000000000000 -r 846a274c92a4 .flake8
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/.flake8 Sat Sep 12 15:36:37 2020 +0200
@@ -0,0 +1,2 @@
+[flake8]
+ignore=E123,E124,E126,E128,W503
diff -r 000000000000 -r 846a274c92a4 COPYRIGHT
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/COPYRIGHT Sat Sep 12 15:36:37 2020 +0200
@@ -0,0 +1,16 @@
+Copyright (C) 2018 Sergi Almacellas Abellana
+Copyright (C) 2017-2019 Cédric Krier
+Copyright (C) 2017-2019 B2CK
+
+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 846a274c92a4 LICENSE
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/LICENSE Sat Sep 12 15:36:37 2020 +0200
@@ -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 846a274c92a4 MANIFEST.in
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/MANIFEST.in Sat Sep 12 15:36:37 2020 +0200
@@ -0,0 +1,5 @@
+include CHANGELOG
+include COPYRIGHT
+include LICENSE
+include README.rst
+include doc/*
diff -r 000000000000 -r 846a274c92a4 README.rst
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/README.rst Sat Sep 12 15:36:37 2020 +0200
@@ -0,0 +1,1 @@
+doc/index.rst
\ No newline at end of file
diff -r 000000000000 -r 846a274c92a4 __init__.py
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/__init__.py Sat Sep 12 15:36:37 2020 +0200
@@ -0,0 +1,28 @@
+# 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
+from . import ir
+from . import web
+from . import routes
+
+__all__ = ['register', 'routes']
+
+
+def register():
+ Pool.register(
+ marketing.Email,
+ marketing.EmailList,
+ marketing.Message,
+ marketing.SendTestView,
+ ir.Cron,
+ web.ShortenedURL,
+ module='marketing_email', type_='model')
+ Pool.register(
+ marketing.SendTest,
+ module='marketing_email', type_='wizard')
+ Pool.register(
+ marketing.EmailSubscribe,
+ marketing.EmailUnsubscribe,
+ module='marketing_email', type_='report')
diff -r 000000000000 -r 846a274c92a4 doc/index.rst
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/index.rst Sat Sep 12 15:36:37 2020 +0200
@@ -0,0 +1,59 @@
+Marketing Email Module
+######################
+
+The marketing_email module manages mailing lists.
+
+Mailing List
+************
+
+A mailing list groups emails under a name and a language
+
+Email
+*****
+
+It stores emails for a mailing list and provides links to the related party or
+web user.
+
+Two actions are available:
+
+- *Request Subscribe* which sends an e-mail to confirm the subscription to a
+ list.
+
+- *Request Unsubscribe* which sends an e-mail to confirm the unsubscription of
+ an email address from the list.
+
+Message
+*******
+
+It stores a message to send to all e-mails addresses on a list. A message is
+defined by:
+
+ * From: the address from which the message is sent.
+ * List: the list of addresses to send the message to.
+ * Title
+ * Content
+ * State:
+
+ * Draft
+ * Sending
+ * Sent
+
+A wizard is available that sends a message to a unique e-mail address from the
+list for test purposes.
+
+Configuration
+*************
+
+The marketing_email module uses parameters from the section:
+
+- `[marketing]`:
+
+ - `email_from`: The default `From` for the e-mails that get sent.
+
+ - `email_subscribe_url`: the URL to confirm the subscription to which the
+ parameter `token` will be added.
+
+ - `email_unsubscribe_url`: the URL to unsubscribe an e-mail address to
+ which the parameter `token` will be added.
+
+ - `email_spy_pixel`: A boolean to activate spy pixel. Disable by default.
diff -r 000000000000 -r 846a274c92a4 email_subscribe.html
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/email_subscribe.html Sat Sep 12 15:36:37 2020 +0200
@@ -0,0 +1,42 @@
+<!DOCTYPE html>
+<html xmlns:py="http://genshi.edgewall.org/";>
+ <head>
+ <title>Subscription Request</title>
+ </head>
+ <body>
+ <py:for each="record in records">
+ <div style="display: block; text-align: center">
+ <div>
+ <h1>Just one more step...</h1>
+ <py:choose>
+ <py:when test="record.party and record.party.name">
+ <p>${record.party.name}</p>
+ </py:when>
+ <py:otherwise>
+ <p>${record.email}</p>
+ </py:otherwise>
+ </py:choose>
+ <form action="${record.get_email_subscribe_url()}">
+ <py:for each="name, value in
extract_params(record.get_email_subscribe_url())">
+ <input type="hidden" name="${name}" value="${value}"/>
+ </py:for>
+ <button type="submit"
+ style="cursor: pointer
+ padding: 0.5em 1em; font-size: 2em;
+ border: 1px solid #2E6DA4; border-radius: 4px;
+ color: #FFF; background-color: #337AB7;">
+ Subscribe to ${record.list_.name}
+ </button>
+ </form>
+ </div>
+ <hr style="margin-top: 20px;
+ border-style: solid none none; border-color: #EEE"></hr>
+ <div style="font-size: 80%; color: #777">
+ <p>Button is not working? Paste this into your browser:</p>
+ <p>${record.get_email_subscribe_url()}</p>
+ <p>If you received this email by mistake, just ignore it.</p>
+ </div>
+ </div>
+ </py:for>
+ </body>
+</html>
diff -r 000000000000 -r 846a274c92a4 email_unsubscribe.html
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/email_unsubscribe.html Sat Sep 12 15:36:37 2020 +0200
@@ -0,0 +1,42 @@
+<!DOCTYPE html>
+<html xmlns:py="http://genshi.edgewall.org/";>
+ <head>
+ <title>Request to Unsubscribe</title>
+ </head>
+ <body>
+ <py:for each="record in records">
+ <div style="display: block; text-align: center">
+ <div>
+ <h1>Just one more step...</h1>
+ <py:choose>
+ <py:when test="record.party and record.party.name">
+ <p>${record.party.name}</p>
+ </py:when>
+ <py:otherwise>
+ <p>${record.email}</p>
+ </py:otherwise>
+ </py:choose>
+ <form action="${record.get_email_unsubscribe_url()}">
+ <py:for each="name, value in
extract_params(record.get_email_unsubscribe_url())">
+ <input type="hidden" name="${name}" value="${value}"/>
+ </py:for>
+ <button type="submit"
+ style="cursor: pointer
+ padding: 0.5em 1em; font-size: 2em;
+ border: 1px solid #2E6DA4; border-radius: 4px;
+ color: #FFF; background-color: #337AB7;">
+ Unsubscribe from ${record.list_.name}
+ </button>
+ </form>
+ </div>
+ <hr style="margin-top: 20px;
+ border-style: solid none none; border-color: #EEE"></hr>
+ <div style="font-size: 80%; color: #777">
+ <p>Button is not working? Paste this into your browser:</p>
+ <p>${record.get_email_unsubscribe_url()}</p>
+ <p>If you received this email by mistake, just ignore it.</p>
+ </div>
+ </div>
+ </py:for>
+ </body>
+</html>
diff -r 000000000000 -r 846a274c92a4 empty.gif
Binary file empty.gif has changed
diff -r 000000000000 -r 846a274c92a4 exceptions.py
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/exceptions.py Sat Sep 12 15:36:37 2020 +0200
@@ -0,0 +1,8 @@
+# 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 TemplateError(ValidationError):
+ pass
diff -r 000000000000 -r 846a274c92a4 icons/tryton-marketing-mail.svg
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/icons/tryton-marketing-mail.svg Sat Sep 12 15:36:37 2020 +0200
@@ -0,0 +1,1 @@
+<svg xmlns="http://www.w3.org/2000/svg"; height="24" viewBox="0 0 24 24"
width="24"><path d="M20 4H4c-1.1 0-1.99.9-1.99 2L2 18c0 1.1.9 2 2 2h16c1.1 0
2-.9 2-2V6c0-1.1-.9-2-2-2zm0 4l-8 5-8-5V6l8 5 8-5v2z"/><path d="M0 0h24v24H0z"
fill="none"/></svg>
\ No newline at end of file
diff -r 000000000000 -r 846a274c92a4 ir.py
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/ir.py Sat Sep 12 15:36:37 2020 +0200
@@ -0,0 +1,15 @@
+# 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 Cron(metaclass=PoolMeta):
+ __name__ = 'ir.cron'
+
+ @classmethod
+ def __setup__(cls):
+ super().__setup__()
+ cls.method.selection.extend([
+ ('marketing.email.message|process',
+ "Send Marketing Messages"),
+ ])
diff -r 000000000000 -r 846a274c92a4 marketing.py
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/marketing.py Sat Sep 12 15:36:37 2020 +0200
@@ -0,0 +1,533 @@
+# 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 random
+import time
+from email.header import Header
+from email.mime.multipart import MIMEMultipart
+from email.mime.text import MIMEText
+from email.utils import formataddr, getaddresses
+from functools import lru_cache
+from urllib.parse import (
+ parse_qs, parse_qsl, urlencode, urlsplit, urlunsplit, urljoin)
+
+from genshi.template import MarkupTemplate
+from genshi.core import START, END, QName, Attrs
+try:
+ import html2text
+except ImportError:
+ html2text = None
+
+from trytond.config import config
+from trytond.i18n import gettext
+from trytond.ir.session import token_hex
+from trytond.model import (
+ DeactivableMixin, Workflow, ModelSQL, ModelView, Unique, fields)
+from trytond.pool import Pool
+from trytond.pyson import Eval
+from trytond.report import Report
+from trytond.report import get_email
+from trytond.sendmail import sendmail_transactional, SMTPDataManager
+from trytond.tools import grouped_slice
+from trytond.transaction import Transaction
+from trytond.url import http_host
+from trytond.wizard import Wizard, StateView, StateTransition, Button
+
+from .exceptions import TemplateError
+
+if not config.get(
+ 'html', 'plugins-marketing.email.message-content'):
+ config.set(
+ 'html', 'plugins-marketing.email.message-content',
+ 'fullpage')
+
+URL_BASE = config.get('marketing', 'email_base', default=http_host())
+URL_OPEN = urljoin(URL_BASE, '/m/empty.gif')
+
+
+def _formataddr(name, email):
+ if name:
+ name = str(Header(name, 'utf-8'))
+ return formataddr((name, email))
+
+
+def _add_params(url, **params):
+ parts = urlsplit(url)
+ query = parse_qsl(parts.query)
+ for key, value in sorted(params.items()):
+ query.append((key, value))
+ parts = list(parts)
+ parts[3] = urlencode(query)
+ return urlunsplit(parts)
+
+
+def _extract_params(url):
+ return parse_qsl(urlsplit(url).query)
+
+
+class Email(DeactivableMixin, ModelSQL, ModelView):
+ "Marketing E-mail"
+ __name__ = 'marketing.email'
+ _rec_name = 'email'
+
+ email = fields.Char("E-mail", required=True)
+ list_ = fields.Many2One('marketing.email.list', "List", required=True)
+ email_token = fields.Char("E-mail Token", required=True)
+ web_user = fields.Function(
+ fields.Many2One('web.user', "Web User"), 'get_web_user')
+ party = fields.Function(
+ fields.Many2One('party.party', "Party"), 'get_web_user')
+
+ @classmethod
+ def __setup__(cls):
+ super().__setup__()
+
+ t = cls.__table__()
+ cls._sql_constraints = [
+ ('email_list_unique', Unique(t, t.email, t.list_),
+ 'marketing.msg_email_list_unique'),
+ ]
+
+ @classmethod
+ def __register__(cls, module_name):
+ super().__register__(module_name)
+
+ table_h = cls.__table_handler__(module_name)
+ table_h.index_action(['email', 'list_'], action='add')
+ table_h.index_action(['list_', 'active'], action='add')
+
+ @classmethod
+ def default_email_token(cls, nbytes=None):
+ return token_hex(nbytes)
+
+ @classmethod
+ def get_web_user(cls, records, names):
+ pool = Pool()
+ WebUser = pool.get('web.user')
+ result = {}
+ web_user = 'web_user' in names
+ if web_user:
+ web_users = dict.fromkeys(list(map(int, records)))
+ result['web_user'] = web_users
+ party = 'party' in names
+ if party:
+ parties = dict.fromkeys(list(map(int, records)))
+ result['party'] = parties
+ for sub_records in grouped_slice(records):
+ email2id = {r.email: r.id for r in sub_records}
+ users = WebUser.search([
+ ('email', 'in', list(email2id.keys())),
+ ])
+ if web_user:
+ web_users.update((email2id[u.email], u.id) for u in users)
+ if party:
+ parties.update(
+ (email2id[u.email], u.party.id)
+ for u in users if u.party)
+ return result
+
+ @classmethod
+ def _format_email(cls, records):
+ for record in records:
+ email = record.email.lower()
+ if email != record.email:
+ record.email = email
+ cls.save(records)
+
+ @classmethod
+ def create(cls, vlist):
+ records = super().create(vlist)
+ cls._format_email(records)
+ return records
+
+ @classmethod
+ def write(cls, *args):
+ super().write(*args)
+ records = sum(args[0:None:2], [])
+ cls._format_email(records)
+
+ def get_email_subscribe(self, report_name='marketing.email.subscribe'):
+ pool = Pool()
+ ActionReport = pool.get('ir.action.report')
+ report, = ActionReport.search([
+ ('report_name', '=', report_name),
+ ], limit=1)
+ return get_email(report, self, [self.list_.language])
+
+ def get_email_subscribe_url(self, url=None):
+ if url is None:
+ url = config.get('marketing', 'email_subscribe_url')
+ return _add_params(url, token=self.email_token)
+
+ @classmethod
+ def subscribe_url(cls, url):
+ parts = urlsplit(url)
+ tokens = filter(
+ None, parse_qs(parts.query).get('token', [None]))
+ return cls.subscribe(list(tokens))
+
+ @classmethod
+ def subscribe(cls, tokens):
+ # Make it slow to prevent brute force attacks
+ delay = config.getint('marketing', 'subscribe_delay', default=1)
+ Transaction().atexit(time.sleep, delay)
+ with Transaction().set_context(active_test=False):
+ records = cls.search([
+ ('email_token', 'in', tokens),
+ ])
+ cls.write(records, {'active': True})
+ return bool(records)
+
+ def get_email_unsubscribe(self, report_name='marketing.email.unsubscribe'):
+ pool = Pool()
+ ActionReport = pool.get('ir.action.report')
+ report, = ActionReport.search([
+ ('report_name', '=', report_name),
+ ], limit=1)
+ return get_email(report, self, [self.list_.language])
+
+ def get_email_unsubscribe_url(self, url=None):
+ if url is None:
+ url = config.get('marketing', 'email_unsubscribe_url')
+ return _add_params(url, token=self.email_token)
+
+ @classmethod
+ def unsubscribe_url(cls, url):
+ parts = urlsplit(url)
+ tokens = filter(
+ None, parse_qs(parts.query).get('token', [None]))
+ cls.unsubscribe(list(tokens))
+
+ @classmethod
+ def unsubscribe(cls, tokens):
+ # Make it slow to prevent brute force attacks
+ delay = config.getint('marketing', 'subscribe_delay', default=1)
+ Transaction().atexit(time.sleep, delay)
+ records = cls.search([
+ ('email_token', 'in', tokens),
+ ])
+ cls.write(records, {'active': False})
+ return bool(records)
+
+
+class EmailSubscribe(Report):
+ __name__ = 'marketing.email.subscribe'
+
+ @classmethod
+ def get_context(cls, records, data):
+ context = super().get_context(records, data)
+ context['extract_params'] = _extract_params
+ return context
+
+
+class EmailUnsubscribe(Report):
+ __name__ = 'marketing.email.unsubscribe'
+
+ @classmethod
+ def get_context(cls, records, data):
+ context = super().get_context(records, data)
+ context['extract_params'] = _extract_params
+ return context
+
+
+class EmailList(ModelSQL, ModelView):
+ "Marketing Mailing List"
+ __name__ = 'marketing.email.list'
+
+ name = fields.Char("Name", required=True)
+ active = fields.Boolean("Active", select=True)
+ language = fields.Many2One('ir.lang', "Language", required=True)
+ emails = fields.One2Many('marketing.email', 'list_', "Emails")
+
+ @classmethod
+ def default_active(cls):
+ return True
+
+ @staticmethod
+ def default_language():
+ Lang = Pool().get('ir.lang')
+ code = Transaction().context.get(
+ 'language', config.get('database', 'language'))
+ try:
+ lang, = Lang.search([
+ ('code', '=', code),
+ ('translatable', '=', True),
+ ], limit=1)
+ return lang.id
+ except ValueError:
+ return None
+
+ def request_subscribe(self, email, from_=None):
+ pool = Pool()
+ Email = pool.get('marketing.email')
+
+ # Randomize processing time to prevent guessing whether the email
+ # address is already subscribed to the list or not.
+ Transaction().atexit(time.sleep, random.random())
+
+ email = email.lower()
+ with Transaction().set_context(active_test=False):
+ records = Email.search([
+ ('email', '=', email),
+ ('list_', '=', self.id),
+ ])
+ if not records:
+ record = Email(email=email, list_=self.id, active=False)
+ record.save()
+ else:
+ record, = records
+ if not record.active:
+ from_ = (from_
+ or config.get('marketing', 'email_from')
+ or config.get('email', 'from'))
+ msg, title = record.get_email_subscribe()
+ msg['From'] = from_
+ msg['To'] = record.email
+ msg['Subject'] = Header(title, 'utf-8')
+ sendmail_transactional(from_, [record.email], msg)
+
+ def request_unsubscribe(self, email, from_=None):
+ pool = Pool()
+ Email = pool.get('marketing.email')
+
+ # Randomize processing time to prevent guessing whether the email
+ # address was subscribed to the list or not.
+ Transaction().atexit(time.sleep, random.random())
+
+ email = email.lower()
+ with Transaction().set_context(active_test=False):
+ records = Email.search([
+ ('email', '=', email),
+ ('list_', '=', self.id),
+ ])
+ if records:
+ record, = records
+ if record.active:
+ from_ = (from_
+ or config.get('marketing', 'email_from')
+ or config.get('email', 'from'))
+ msg, title = record.get_email_unsubscribe()
+ msg['From'] = from_
+ msg['To'] = record.email
+ msg['Subject'] = Header(title, 'utf-8')
+ sendmail_transactional(from_, [record.email], msg)
+
+
+class Message(Workflow, ModelSQL, ModelView):
+ "Marketing E-mail Message"
+ __name__ = 'marketing.email.message'
+ _rec_name = 'title'
+
+ _states = {
+ 'readonly': Eval('state') != 'draft',
+ }
+ _depends = ['state']
+ from_ = fields.Char(
+ "From", states=_states, depends=_depends,
+ help="Leave empty for the value defined in the configuration file.")
+ list_ = fields.Many2One(
+ 'marketing.email.list', "List",
+ required=True, states=_states, depends=_depends)
+ title = fields.Char(
+ "Title", required=True, states=_states, depends=_depends)
+ content = fields.Text(
+ "Content",
+ states={
+ 'required': Eval('state') != 'draft',
+ 'readonly': _states['readonly'],
+ },
+ depends=['state'] + _depends)
+ urls = fields.One2Many(
+ 'web.shortened_url', 'record', "URLs", readonly=True)
+ state = fields.Selection([
+ ('draft', "Draft"),
+ ('sending', "Sending"),
+ ('sent', "Sent"),
+ ], "State", readonly=True, select=True)
+ del _states, _depends
+
+ @classmethod
+ def __setup__(cls):
+ super().__setup__()
+ cls._transitions |= set([
+ ('draft', 'sending'),
+ ('sending', 'sent'),
+ ('sending', 'draft'),
+ ])
+ cls._buttons.update({
+ 'draft': {
+ 'invisible': Eval('state') != 'sending',
+ 'depends': ['state'],
+ },
+ 'send': {
+ 'invisible': Eval('state') != 'draft',
+ 'depends': ['state'],
+ },
+ 'send_test': {
+ 'invisible': Eval('state') != 'draft',
+ 'depends': ['state'],
+ },
+ })
+
+ @classmethod
+ def default_state(cls):
+ return 'draft'
+
+ @classmethod
+ def validate(cls, messages):
+ super().validate(messages)
+ for message in messages:
+ message.check_content()
+
+ def check_content(self):
+ if not self.content:
+ return
+ try:
+ MarkupTemplate(self.content)
+ except Exception as exception:
+ raise TemplateError(
+ gettext('marketing_email'
+ '.msg_message_invalid_content',
+ message=self.rec_name,
+ exception=exception)) from exception
+
+ @classmethod
+ @ModelView.button
+ @Workflow.transition('draft')
+ def draft(cls, messages):
+ pass
+
+ @classmethod
+ @ModelView.button_action('marketing_email.wizard_send_test')
+ def send_test(cls, messages):
+ pass
+
+ @classmethod
+ @ModelView.button
+ @Workflow.transition('sending')
+ def send(cls, messages):
+ pass
+
+ @classmethod
+ @Workflow.transition('sent')
+ def sent(cls, messages):
+ pass
+
+ @classmethod
+ def process(cls, messages=None, emails=None, smtpd_datamanager=None):
+ pool = Pool()
+ WebShortener = pool.get('web.shortened_url')
+ spy_pixel = config.getboolean(
+ 'marketing', 'email_spy_pixel', default=False)
+
+ @lru_cache(None)
+ def short(url, record):
+ url = WebShortener(
+ record=record,
+ redirect_url=url)
+ url.save()
+ return url.shortened_url
+
+ def convert_href(message):
+ def filter_(stream):
+ for kind, data, pos in stream:
+ if kind is START:
+ tag, attrs = data
+ if tag == 'a':
+ href = attrs.get('href')
+ attrs -= 'href'
+ href = short(href, str(message))
+ attrs |= [(QName('href'), href)]
+ data = tag, attrs
+ elif kind is END and data == 'body' and spy_pixel:
+ yield START, (QName('img'), Attrs([
+ (QName('src'), short(
+ URL_OPEN, str(message))),
+ (QName('height'), '1'),
+ (QName('width'), '1'),
+ ])), pos
+ yield END, QName('img'), pos
+ yield kind, data, pos
+ return filter_
+
+ if not smtpd_datamanager:
+ smtpd_datamanager = SMTPDataManager()
+ if messages is None:
+ messages = cls.search([
+ ('state', '=', 'sending'),
+ ])
+
+ for message in messages:
+ template = MarkupTemplate(message.content)
+ for email in (emails or message.list_.emails):
+ content = (template
+ .generate(email=email)
+ .filter(convert_href(message))
+ .render())
+
+ name = email.party.rec_name if email.party else ''
+ from_ = (message.from_
+ or config.get('marketing', 'email_from')
+ or config.get('email', 'from'))
+ to = _formataddr(name, email.email)
+
+ msg = MIMEMultipart('alternative')
+ msg['From'] = from_
+ msg['To'] = to
+ msg['Subject'] = Header(message.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)
+
+ sendmail_transactional(
+ from_, getaddresses([to]), msg,
+ datamanager=smtpd_datamanager)
+ if not emails:
+ cls.sent(messages)
+
+
+class SendTest(Wizard):
+ "Send Test E-mail"
+ __name__ = 'marketing.email.send_test'
+ start = StateView(
+ 'marketing.email.send_test',
+ 'marketing_email.send_test_view_form', [
+ Button("Cancel", 'end', 'tryton-cancel'),
+ Button("Send", 'send', 'tryton-ok', default=True),
+ ])
+ send = StateTransition()
+
+ def default_start(self, fields):
+ pool = Pool()
+ Message = pool.get('marketing.email.message')
+
+ message = Message(Transaction().context.get('active_id'))
+ return {
+ 'list_': message.list_.id,
+ 'message': message.id,
+ }
+
+ def transition_send(self):
+ pool = Pool()
+ Message = pool.get('marketing.email.message')
+ Message.process([self.start.message], [self.start.email])
+ return 'end'
+
+
+class SendTestView(ModelView):
+ "Send Test E-mail"
+ __name__ = 'marketing.email.send_test'
+
+ list_ = fields.Many2One(
+ 'marketing.email.list', "List", readonly=True)
+ message = fields.Many2One(
+ 'marketing.email.message', "Message", readonly=True)
+ email = fields.Many2One(
+ 'marketing.email', "E-Mail", required=True,
+ domain=[
+ ('list_', '=', Eval('list_')),
+ ],
+ depends=['list_'])
diff -r 000000000000 -r 846a274c92a4 marketing.xml
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/marketing.xml Sat Sep 12 15:36:37 2020 +0200
@@ -0,0 +1,214 @@
+<?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.icon" id="mail_icon">
+ <field name="name">tryton-marketing-mail</field>
+ <field name="path">icons/tryton-marketing-mail.svg</field>
+ </record>
+
+ <record model="ir.ui.view" id="email_view_form">
+ <field name="model">marketing.email</field>
+ <field name="type">form</field>
+ <field name="name">email_form</field>
+ </record>
+
+ <record model="ir.ui.view" id="email_view_list">
+ <field name="model">marketing.email</field>
+ <field name="type">tree</field>
+ <field name="name">email_list</field>
+ </record>
+
+ <record model="ir.action.act_window" id="act_email_relate_list">
+ <field name="name">E-mails</field>
+ <field name="res_model">marketing.email</field>
+ <field name="domain" eval="[('list_', '=', Eval('active_id'))]"
pyson="1"/>
+ </record>
+ <record model="ir.action.keyword" id="act_email_relate_list_keyword1">
+ <field name="keyword">form_relate</field>
+ <field name="model">marketing.email.list,-1</field>
+ <field name="action" ref="act_email_relate_list"/>
+ </record>
+
+ <record model="ir.model.access" id="access_email">
+ <field name="model" search="[('model', '=', 'marketing.email')]"/>
+ <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_email_marketing_email">
+ <field name="model" search="[('model', '=', 'marketing.email')]"/>
+ <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="email_list_view_form">
+ <field name="model">marketing.email.list</field>
+ <field name="type">form</field>
+ <field name="name">email_list_form</field>
+ </record>
+
+ <record model="ir.ui.view" id="email_list_view_list">
+ <field name="model">marketing.email.list</field>
+ <field name="type">tree</field>
+ <field name="name">email_list_list</field>
+ </record>
+
+ <record model="ir.action.act_window" id="act_email_list_form">
+ <field name="name">Mailing Lists</field>
+ <field name="res_model">marketing.email.list</field>
+ </record>
+ <record model="ir.action.act_window.view"
id="act_email_list_form_view1">
+ <field name="sequence" eval="10"/>
+ <field name="view" ref="email_list_view_list"/>
+ <field name="act_window" ref="act_email_list_form"/>
+ </record>
+ <record model="ir.action.act_window.view"
id="act_email_list_form_view2">
+ <field name="sequence" eval="20"/>
+ <field name="view" ref="email_list_view_form"/>
+ <field name="act_window" ref="act_email_list_form"/>
+ </record>
+ <menuitem parent="marketing.menu_marketing"
action="act_email_list_form" id="menu_email_list_form"/>
+
+ <record model="ir.model.access" id="access_email_list">
+ <field name="model" search="[('model', '=',
'marketing.email.list')]"/>
+ <field name="perm_read" eval="True"/>
+ <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_email_list_marketing_email">
+ <field name="model" search="[('model', '=',
'marketing.email.list')]"/>
+ <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.action.report" id="report_email_subscribe">
+ <field name="name">Subscribe Request</field>
+ <field name="model">marketing.email</field>
+ <field name="report_name">marketing.email.subscribe</field>
+ <field name="report">marketing_email/email_subscribe.html</field>
+ <field name="template_extension">html</field>
+ </record>
+ <record model="ir.action.report" id="report_email_unsubscribe">
+ <field name="name">Unsubscribe Request</field>
+ <field name="model">marketing.email</field>
+ <field name="report_name">marketing.email.unsubscribe</field>
+ <field name="report">marketing_email/email_unsubscribe.html</field>
+ <field name="template_extension">html</field>
+ </record>
+
+ <record model="ir.ui.view" id="email_message_view_form">
+ <field name="model">marketing.email.message</field>
+ <field name="type">form</field>
+ <field name="name">email_message_form</field>
+ </record>
+
+ <record model="ir.ui.view" id="email_message_view_list">
+ <field name="model">marketing.email.message</field>
+ <field name="type">tree</field>
+ <field name="name">email_message_list</field>
+ </record>
+
+ <record model="ir.action.act_window" id="act_email_message_form">
+ <field name="name">Messages</field>
+ <field name="res_model">marketing.email.message</field>
+ <field name="domain" eval="[('list_', '=', Eval('active_id'))]"
pyson="1"/>
+ </record>
+ <record model="ir.action.act_window.view"
id="act_email_message_form_view1">
+ <field name="sequence" eval="10"/>
+ <field name="view" ref="email_message_view_list"/>
+ <field name="act_window" ref="act_email_message_form"/>
+ </record>
+ <record model="ir.action.act_window.view"
id="act_email_message_form_view2">
+ <field name="sequence" eval="20"/>
+ <field name="view" ref="email_message_view_form"/>
+ <field name="act_window" ref="act_email_message_form"/>
+ </record>
+ <record model="ir.action.act_window.domain"
id="act_email_message_form_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_email_message_form"/>
+ </record>
+ <record model="ir.action.act_window.domain"
id="act_email_message_form_sending">
+ <field name="name">Sending</field>
+ <field name="sequence" eval="20"/>
+ <field name="domain" eval="[('state', '=', 'sending')]" pyson="1"/>
+ <field name="count" eval="True"/>
+ <field name="act_window" ref="act_email_message_form"/>
+ </record>
+ <record model="ir.action.act_window.domain"
id="act_email_message_form_all">
+ <field name="name">All</field>
+ <field name="sequence" eval="9999"/>
+ <field name="domain"/>
+ <field name="act_window" ref="act_email_message_form"/>
+ </record>
+ <record model="ir.action.keyword" id="act_email_message_form_keyword1">
+ <field name="keyword">form_relate</field>
+ <field name="model">marketing.email.list,-1</field>
+ <field name="action" ref="act_email_message_form"/>
+ </record>
+
+ <record model="ir.model.button" id="message_draft_button">
+ <field name="name">draft</field>
+ <field name="string">Draft</field>
+ <field name="model" search="[('model', '=',
'marketing.email.message')]"/>
+ </record>
+
+ <record model="ir.model.button" id="message_send_button">
+ <field name="name">send</field>
+ <field name="string">Send</field>
+ <field name="model" search="[('model', '=',
'marketing.email.message')]"/>
+ </record>
+
+ <record model="ir.model.button" id="message_send_test_button">
+ <field name="name">send_test</field>
+ <field name="string">Send Test</field>
+ <field name="model" search="[('model', '=',
'marketing.email.message')]"/>
+ </record>
+
+ <record model="ir.model.access" id="access_email_message">
+ <field name="model" search="[('model', '=',
'marketing.email.message')]"/>
+ <field name="perm_read" eval="True"/>
+ <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_email_message_marketing_email">
+ <field name="model" search="[('model', '=',
'marketing.email.message')]"/>
+ <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.action.wizard" id="wizard_send_test">
+ <field name="name">Send Test</field>
+ <field name="wiz_name">marketing.email.send_test</field>
+ <field name="model">marketing.email.message</field>
+ </record>
+
+ <record model="ir.ui.view" id="send_test_view_form">
+ <field name="model">marketing.email.send_test</field>
+ <field name="type">form</field>
+ <field name="name">send_test_form</field>
+ </record>
+
+ <record model="ir.cron" id="cron_send_messages">
+ <field name="method">marketing.email.message|process</field>
+ <field name="interval_number" eval="15"/>
+ <field name="interval_type">minutes</field>
+ </record>
+ </data>
+</tryton>
diff -r 000000000000 -r 846a274c92a4 message.xml
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/message.xml Sat Sep 12 15:36:37 2020 +0200
@@ -0,0 +1,14 @@
+<?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 grouped="1">
+ <record model="ir.message" id="msg_email_list_unique">
+ <field name="text">Email addresses can only be subscribed once to
each list.</field>
+ </record>
+
+ <record model="ir.message" id="msg_message_invalid_content">
+ <field name="text">Invalid content in message "%(message)s" with
exception "%(exception)s".</field>
+ </record>
+ </data>
+</tryton>
diff -r 000000000000 -r 846a274c92a4 routes.py
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/routes.py Sat Sep 12 15:36:37 2020 +0200
@@ -0,0 +1,12 @@
+# 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 trytond.tools import file_open
+from trytond.wsgi import app
+
+
[email protected]('/m/empty.gif')
+def empty(request):
+ fp = file_open('marketing_email/empty.gif', mode='rb')
+ return Response(fp, 200, content_type='image/gif', direct_passthrough=True)
diff -r 000000000000 -r 846a274c92a4 setup.py
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/setup.py Sat Sep 12 15:36:37 2020 +0200
@@ -0,0 +1,132 @@
+#!/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(os.path.join(os.path.dirname(__file__), '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_email'
+
+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 manage marketing mailing lists',
+ long_description=read('README.rst'),
+ author='Tryton',
+ author_email='[email protected]',
+ url='http://www.tryton.org/',
+ download_url=download_url,
+ project_urls={
+ "Bug Tracker": 'https://bugs.tryton.org/',
+ "Documentation": 'https://docs.tryton.org/',
+ "Forum": 'https://www.tryton.org/forum',
+ "Source Code": 'https://hg.tryton.org/modules/marketing_email',
+ },
+ keywords='tryton marketing email list',
+ package_dir={'trytond.modules.marketing_email': '.'},
+ packages=(
+ ['trytond.modules.marketing_email']
+ + ['trytond.modules.marketing_email.%s' % p for p in find_packages()]
+ ),
+ package_data={
+ 'trytond.modules.marketing_email': (info.get('xml', [])
+ + ['tryton.cfg', 'view/*.xml', 'locale/*.po', '*.fodt', '*.html',
+ '*.gif', 'icons/*.svg', 'tests/*.rst']),
+ },
+ 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 :: Finnish',
+ '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',
+ 'Natural Language :: Turkish',
+ 'Operating System :: OS Independent',
+ 'Programming Language :: Python :: 3',
+ '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.5',
+ install_requires=requires,
+ dependency_links=dependency_links,
+ zip_safe=False,
+ entry_points="""
+ [trytond.modules]
+ marketing_email = trytond.modules.marketing_email
+ """,
+ test_suite='tests',
+ test_loader='trytond.test_loader:Loader',
+ tests_require=tests_require,
+ )
diff -r 000000000000 -r 846a274c92a4 tests/__init__.py
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/tests/__init__.py Sat Sep 12 15:36:37 2020 +0200
@@ -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_email.tests.test_marketing_email import
suite # noqa: E501
+except ImportError:
+ from .test_marketing_email import suite
+
+__all__ = ['suite']
diff -r 000000000000 -r 846a274c92a4 tests/test_marketing_email.py
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/tests/test_marketing_email.py Sat Sep 12 15:36:37 2020 +0200
@@ -0,0 +1,165 @@
+# 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
+from unittest.mock import patch, ANY, Mock
+
+from trytond.config import config
+from trytond.pool import Pool
+from trytond.tests.test_tryton import ModuleTestCase, with_transaction
+from trytond.tests.test_tryton import suite as test_suite
+from trytond.transaction import Transaction
+
+from trytond.modules.marketing_email import marketing as marketing_module
+
+SUBSCRIBE_URL = 'http://www.example.com/subscribe'
+UNSUBSCRIBE_URL = 'http://www.example.com/unsubscribe'
+FROM = '[email protected]'
+
+
+class MarketingEmailTestCase(ModuleTestCase):
+ 'Test Marketing Email module'
+ module = 'marketing_email'
+
+ def setUp(self):
+ super().setUp()
+ if not config.has_section('marketing'):
+ config.add_section('marketing')
+ subscribe_url = config.get(
+ 'marketing', 'email_subscribe_url', default='')
+ config.set('marketing', 'email_subscribe_url', SUBSCRIBE_URL)
+ self.addCleanup(
+ lambda: config.set(
+ 'marketing', 'email_subscribe_url', subscribe_url))
+ unsubscribe_url = config.get(
+ 'marketing', 'email_unsubscribe_url', default='')
+ config.set('marketing', 'email_unsubscribe_url', UNSUBSCRIBE_URL)
+ self.addCleanup(
+ lambda: config.set(
+ 'marketing', 'email_unsubscribe_url', unsubscribe_url))
+ spy_pixel = config.get('marketing', 'email_spy_pixel', default='')
+ config.set('marketing', 'email_spy_pixel', 'true')
+ self.addCleanup(
+ lambda: config.set('marketing', 'email_spy_pixel', spy_pixel))
+ from_ = config.get('email', 'from', default='')
+ config.set('email', 'from', FROM)
+ self.addCleanup(lambda: config.set('email', 'from', from_))
+
+ @with_transaction()
+ def test_subscribe(self):
+ "Test subscribe"
+ pool = Pool()
+ Email = pool.get('marketing.email')
+ EmailList = pool.get('marketing.email.list')
+
+ email_list = EmailList(name="Test")
+ email_list.save()
+
+ with patch.object(
+ marketing_module, 'sendmail_transactional') as sendmail:
+ email_list.request_subscribe('[email protected]')
+ sendmail.assert_called_once_with(FROM, ['[email protected]'], ANY)
+
+ with Transaction().set_context(active_test=False):
+ email, = Email.search([
+ ('list_', '=', email_list.id),
+ ])
+ token = email.email_token
+ self.assertTrue(token)
+ self.assertFalse(email.active)
+
+ self.assertEqual(
+ email.get_email_subscribe_url(),
+ '%s?token=%s' % (SUBSCRIBE_URL, token))
+
+ Email.subscribe_url(SUBSCRIBE_URL)
+ self.assertFalse(email.active)
+
+ Email.subscribe_url('%s?token=12345' % SUBSCRIBE_URL)
+ self.assertFalse(email.active)
+
+ Email.subscribe_url(email.get_email_subscribe_url())
+ self.assertTrue(email.active)
+
+ @with_transaction()
+ def test_unsubscribe(self):
+ "Test unsubscribe"
+ pool = Pool()
+ Email = pool.get('marketing.email')
+ EmailList = pool.get('marketing.email.list')
+
+ email_list = EmailList(name="Test")
+ email_list.save()
+
+ email = Email(email='[email protected]', list_=email_list.id)
+ email.save()
+
+ token = email.email_token
+ self.assertTrue(token)
+ self.assertTrue(email.active)
+
+ with patch.object(
+ marketing_module, 'sendmail_transactional') as sendmail:
+ email_list.request_unsubscribe('[email protected]')
+ sendmail.assert_called_once_with(FROM, ['[email protected]'], ANY)
+
+ self.assertEqual(
+ email.get_email_unsubscribe_url(),
+ '%s?token=%s' % (UNSUBSCRIBE_URL, token))
+
+ Email.unsubscribe_url(UNSUBSCRIBE_URL)
+ self.assertTrue(email.active)
+
+ Email.unsubscribe_url('%s?token=12345' % UNSUBSCRIBE_URL)
+ self.assertTrue(email.active)
+
+ Email.unsubscribe_url(email.get_email_unsubscribe_url())
+ self.assertFalse(email.active)
+
+ @with_transaction()
+ def test_send_messages(self):
+ "Test messages are sent to the list"
+ pool = Pool()
+ Email = pool.get('marketing.email')
+ EmailList = pool.get('marketing.email.list')
+ Message = pool.get('marketing.email.message')
+ ShortenedURL = pool.get('web.shortened_url')
+
+ email_list = EmailList(name="Test")
+ email_list.save()
+
+ email = Email(email='[email protected]', list_=email_list)
+ email.save()
+ message = Message(list_=email_list)
+ message.title = 'Test'
+ message.content = (
+ '<html>'
+ '<body>'
+ '<a href="http://www.example.com/";>Content</a>'
+ '</body>'
+ '</html>')
+ message.save()
+ Message.send([message])
+
+ with patch.object(
+ marketing_module,
+ 'sendmail_transactional') as sendmail:
+ smtpd_datamanager = Mock()
+ Message.process(smtpd_datamanager=smtpd_datamanager)
+
+ sendmail.assert_called_once_with(
+ FROM, [('', '[email protected]')], ANY,
+ datamanager=smtpd_datamanager)
+ urls = ShortenedURL.search([
+ ('record', '=', str(message)),
+ ])
+
+ self.assertEqual(message.state, 'sent')
+ self.assertEqual(len(urls), 2)
+
+
+def suite():
+ suite = test_suite()
+ suite.addTests(unittest.TestLoader().loadTestsFromTestCase(
+ MarketingEmailTestCase))
+ return suite
diff -r 000000000000 -r 846a274c92a4 tox.ini
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/tox.ini Sat Sep 12 15:36:37 2020 +0200
@@ -0,0 +1,15 @@
+[tox]
+envlist = {py35,py36,py37,py38}-{sqlite,postgresql},pypy3-{sqlite,postgresql}
+
+[testenv]
+commands = {envpython} setup.py test
+deps =
+ {py35,py36,py37,py38}-postgresql: psycopg2 >= 2.5
+ pypy3-postgresql: psycopg2cffi >= 2.5
+ {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 846a274c92a4 tryton.cfg
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/tryton.cfg Sat Sep 12 15:36:37 2020 +0200
@@ -0,0 +1,12 @@
+[tryton]
+version=5.7.0
+depends:
+ ir
+ marketing
+ party
+ res
+ web_user
+ web_shortener
+xml:
+ marketing.xml
+ message.xml
diff -r 000000000000 -r 846a274c92a4 view/email_form.xml
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/view/email_form.xml Sat Sep 12 15:36:37 2020 +0200
@@ -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="list_"/>
+ <field name="list_"/>
+ <label name="active"/>
+ <field name="active"/>
+ <label name="email"/>
+ <field name="email" colspan="3"/>
+</form>
diff -r 000000000000 -r 846a274c92a4 view/email_list.xml
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/view/email_list.xml Sat Sep 12 15:36:37 2020 +0200
@@ -0,0 +1,9 @@
+<?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="list_" expand="2"/>
+ <field name="email" expand="2"/>
+ <field name="party" expand="1"/>
+ <field name="web_user" expand="1"/>
+</tree>
diff -r 000000000000 -r 846a274c92a4 view/email_list_form.xml
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/view/email_list_form.xml Sat Sep 12 15:36:37 2020 +0200
@@ -0,0 +1,14 @@
+<?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="active"/>
+ <field name="active"/>
+ <label name="language"/>
+ <field name="language"/>
+ <group id="links" col="-1" colspan="4">
+ <link icon="tryton-marketing-mail"
name="marketing_email.act_email_message_form"/>
+ </group>
+</form>
diff -r 000000000000 -r 846a274c92a4 view/email_list_list.xml
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/view/email_list_list.xml Sat Sep 12 15:36:37 2020 +0200
@@ -0,0 +1,7 @@
+<?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" expand="2"/>
+ <field name="language" expand="1"/>
+</tree>
diff -r 000000000000 -r 846a274c92a4 view/email_message_form.xml
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/view/email_message_form.xml Sat Sep 12 15:36:37 2020 +0200
@@ -0,0 +1,30 @@
+<?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 cursor="list_">
+ <label name="from_"/>
+ <field name="from_" colspan="3"/>
+ <label name="list_" string="To:"/>
+ <field name="list_" colspan="3"/>
+ <label name="title"/>
+ <field name="title" colspan="3"/>
+ <notebook colspan="4">
+ <page name="content">
+ <label name="content" yfill="1" yalign="0"/>
+ <group col="-1" id="content" colspan="3" yexpand="1">
+ <field name="content"/>
+ <field name="content" string="Edit" widget="html" xexpand="0"/>
+ </group>
+ </page>
+ <page name="urls">
+ <field name="urls" colspan="4"/>
+ </page>
+ </notebook>
+ <label name="state"/>
+ <field name="state"/>
+ <group col="-1" colspan="2" id="buttons">
+ <button name="draft"/>
+ <button name="send_test" colspan="2"/>
+ <button name="send"/>
+ </group>
+</form>
diff -r 000000000000 -r 846a274c92a4 view/email_message_list.xml
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/view/email_message_list.xml Sat Sep 12 15:36:37 2020 +0200
@@ -0,0 +1,9 @@
+<?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="from_"/>
+ <field name="list_"/>
+ <field name="title"/>
+ <field name="state"/>
+</tree>
diff -r 000000000000 -r 846a274c92a4 view/send_test_form.xml
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/view/send_test_form.xml Sat Sep 12 15:36:37 2020 +0200
@@ -0,0 +1,9 @@
+<?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 col="2">
+ <label name="email" string="To:"/>
+ <field name="email"/>
+ <label name="message"/>
+ <field name="message"/>
+</form>
diff -r 000000000000 -r 846a274c92a4 web.py
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/web.py Sat Sep 12 15:36:37 2020 +0200
@@ -0,0 +1,14 @@
+# 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.email.message',
+ ]
