diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..890ff01 --- /dev/null +++ b/.gitignore @@ -0,0 +1,56 @@ +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] + +# C extensions +*.so + +# Distribution / packaging +.Python +env/ +bin/ +build/ +develop-eggs/ +dist/ +eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +*.egg-info/ +.installed.cfg +*.egg + +# Installer logs +pip-log.txt +pip-delete-this-directory.txt + +# Unit test / coverage reports +htmlcov/ +.tox/ +.coverage +.cache +nosetests.xml +coverage.xml + +# Translations +*.mo + +# Pycharm +.idea + +# Mr Developer +.mr.developer.cfg +.project +.pydevproject + +# Rope +.ropeproject + +# Sphinx documentation +docs/_build/ + +# Backup files +*~ +*.swp diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..33dd0bf --- /dev/null +++ b/.travis.yml @@ -0,0 +1,22 @@ +language: python + +python: + - "2.7" + +env: + - VERSION="6.0" ODOO_REPO="odoo/odoo" + - VERSION="6.0" UNIT_TEST="1" + +virtualenv: + system_site_packages: true + +install: + - git clone https://github.com/OCA/maintainer-quality-tools.git ${HOME}/maintainer-quality-tools + - export PATH=${HOME}/maintainer-quality-tools/travis:${PATH} + - travis_install_nightly + +script: + - travis_run_tests + +after_success: + coveralls diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..3ffc567 --- /dev/null +++ b/LICENSE @@ -0,0 +1,661 @@ +GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are 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. + + 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. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + 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 Affero 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. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + 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 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 work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero 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 Affero 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 Affero 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 Affero 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. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero 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 Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + 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 AGPL, see +. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..c1f5350 --- /dev/null +++ b/README.md @@ -0,0 +1,19 @@ +[![Build Status](https://travis-ci.org/OCA/connector-telephony.svg?branch=6.0)](https://travis-ci.org/OCA/connector-telephony) +[![Coverage Status](https://coveralls.io/repos/OCA/connector-telephony/badge.png?branch=6.0)](https://coveralls.io/r/OCA/connector-telephony?branch=6.0) + +# OpenERP-Asterisk connector + +Asterisk is an OpenSource software for telephony. +It is used worldwide to run IPBXes inside companies. +This project connects Asterisk to Odoo/OpenERP. + +This project also provides a serie of modules (base\_phone, base\_phone\_popup, +crm\_phone, hr\_phone, event\_phone, etc...) that are independant from +Asterisk and can be usefull on all Odoo/OpenERP installations. + +The main maintainer of the Asterisk-OpenERP connector is Alexis de Lattre from +Akretion (alexis.delattre \_at\_ akretion.com). + +To know more about the OpenERP-Asterisk connector, refer to the documentation + available on the Akretion website +http://www.akretion.com/en/products-and-services/openerp-asterisk-voip-connector diff --git a/asterisk_click2dial/__terp__.py b/asterisk_click2dial/__terp__.py index 630368a..6229c22 100644 --- a/asterisk_click2dial/__terp__.py +++ b/asterisk_click2dial/__terp__.py @@ -27,26 +27,47 @@ 'license': 'AGPL-3', 'description': """This module adds 3 functionnalities : -1) It adds a 'dial' button in the partner address form view so that users can directly dial a phone number through Asterisk. This feature is usually known as 'click2dial'. Here is how it works : -. In OpenERP, the user clicks on the 'dial' button next to a phone number field in the partner address view. -. OpenERP connects to the Asterisk Manager Interface and Asterisk makes the user's phone ring. +1) It adds a 'dial' button in the partner address form view so that users can + directly dial a phone number through Asterisk. This feature is usually known + as 'click2dial'. Here is how it works : +. In OpenERP, the user clicks on the 'dial' button next to a phone number field + in the partner address view. +. OpenERP connects to the Asterisk Manager Interface and Asterisk makes the + user's phone ring. . The user answers his own phone (if he doesn't, the process stops here). . Asterisk dials the phone number found in OpenERP in place of the user. . If the remote party answers, the user can talk to his correspondent. -2) It adds the ability to show the name of the calling party on the screen of your IP phone on incoming phone calls if the presented -phone number is present in the partner addresses of OpenERP. Here is how it works : -. On incoming phone calls, the Asterisk dialplan executes an AGI script "get_cid_name_timeout.sh". -. The "get_cid_name_timeout.sh" script calls the "get_cid_name.py" script with a short timeout. -. The "get_cid_name.py" script will make an XML-RPC request on the OpenERP server to try to find the name of the person corresponding to the phone number presented by the calling party. -. If it finds the name, it is set as the CallerID name of the call, so as to be presented on the IP phone of the user. +2) It adds the ability to show the name of the calling party on the screen of + your IP phone on incoming phone calls if the presented phone number is + present in the partner addresses of OpenERP. Here is how it works : +. On incoming phone calls, the Asterisk dialplan executes an AGI script + "get_cid_name_timeout.sh". +. The "get_cid_name_timeout.sh" script calls the "get_cid_name.py" script with + a short timeout. +. The "get_cid_name.py" script will make an XML-RPC request on the OpenERP + server to try to find the name of the person corresponding to the phone + number presented by the calling party. +. If it finds the name, it is set as the CallerID name of the call, so as to be + presented on the IP phone of the user. -3) It adds a button "Open calling partner" in the menu "Sales > Address book" to get the partner corresponding to the calling party in one click. Here is how it works : -. When the user clicks on the "Open calling partner" button, OpenERP sends a query to the Asterisk Manager Interface to get a list of the current phone calls -. If it finds a phone call involving the user's phone, it gets the phone number of the calling party -. It searches the phone number of the calling party in the Partner addresses of OpenERP. If a record matches, it shows the name of the related Partner and proposes to open it, or open its related sale orders or invoices. If no record matches, it proposes to create a new Contact with the presented phone number as 'Phone' or 'Mobile' number or update an existing Contact. +3) It adds a button "Open calling partner" in the menu "Sales > Address book" + to get the partner corresponding to the calling party in one click. + Here is how it works : +. When the user clicks on the "Open calling partner" button, OpenERP sends a + query to the Asterisk Manager Interface to get a list of the current phone + calls +. If it finds a phone call involving the user's phone, it gets the phone number + of the calling party +. It searches the phone number of the calling party in the Partner addresses of + OpenERP. If a record matches, it shows the name of the related Partner and + proposes to open it, or open its related sale orders or invoices. If no + record matches, it proposes to create a new Contact with the presented phone + number as 'Phone' or 'Mobile' number or update an existing Contact. -A detailed documentation for this module is available on the Akretion Web site : http://www.akretion.com/en/products-and-services/openerp-asterisk-voip-connector """, +A detailed documentation for this module is available on the Akretion Web site: +http://www.akretion.com/products-and-services/openerp-asterisk-voip-connector +""", 'author': 'Akretion', 'website': 'http://www.akretion.com/', 'depends': ['base'], @@ -63,4 +84,3 @@ A detailed documentation for this module is available on the Akretion Web site : 'installable': True, 'active': False, } - diff --git a/asterisk_click2dial/asterisk_click2dial.py b/asterisk_click2dial/asterisk_click2dial.py index 3caa407..382ed48 100644 --- a/asterisk_click2dial/asterisk_click2dial.py +++ b/asterisk_click2dial/asterisk_click2dial.py @@ -27,33 +27,143 @@ from tools.translate import _ # Lib for phone number reformating -> pip install phonenumbers import phonenumbers # Lib py-asterisk from http://code.google.com/p/py-asterisk/ -# We need a version which has this commit : http://code.google.com/p/py-asterisk/source/detail?r=8d0e1c941cce727c702582f3c9fcd49beb4eeaa4 +# We need a version which has this commit : +# 8d0e1c941cce727c702582f3c9fcd49beb4eeaa4 # so a version after Nov 20th, 2012 from Asterisk import Manager logger = netsvc.Logger() + class asterisk_server(osv.osv): - '''Asterisk server object, to store all the parameters of the Asterisk IPBXs''' + """Asterisk server object, to store all the parameters of the Asterisk + IPBXs + """ _name = "asterisk.server" _description = "Asterisk Servers" _columns = { - 'name': fields.char('Asterisk server name', size=50, required=True, help="Asterisk server name."), - 'active': fields.boolean('Active', help="The active field allows you to hide the Asterisk server without deleting it."), - 'ip_address': fields.char('Asterisk IP addr. or DNS', size=50, required=True, help="IP address or DNS name of the Asterisk server."), - 'port': fields.integer('Port', required=True, help="TCP port on which the Asterisk Manager Interface listens. Defined in /etc/asterisk/manager.conf on Asterisk."), - 'out_prefix': fields.char('Out prefix', size=4, help="Prefix to dial to place outgoing calls. If you don't use a prefix to place outgoing calls, leave empty."), - 'national_prefix': fields.char('National prefix', size=4, help="Prefix for national phone calls (don't include the 'out prefix'). For e.g., in France, the phone numbers look like '01 41 98 12 42' : the National prefix is '0'."), - 'international_prefix': fields.char('International prefix', required=True, size=4, help="Prefix to add to make international phone calls (don't include the 'out prefix'). For e.g., in France, the International prefix is '00'."), - 'country_prefix': fields.char('My country prefix', required=True, size=4, help="Phone prefix of the country where the Asterisk server is located. For e.g. the phone prefix for France is '33'. If the phone number to dial starts with the 'My country prefix', OpenERP will remove the country prefix from the phone number and add the 'out prefix' followed by the 'national prefix'. If the phone number to dial doesn't start with the 'My country prefix', OpenERP will add the 'out prefix' followed by the 'international prefix'."), - 'login': fields.char('AMI login', size=30, required=True, help="Login that OpenERP will use to communicate with the Asterisk Manager Interface. Refer to /etc/asterisk/manager.conf on your Asterisk server."), - 'password': fields.char('AMI password', size=30, required=True, help="Password that Asterisk will use to communicate with the Asterisk Manager Interface. Refer to /etc/asterisk/manager.conf on your Asterisk server."), - 'context': fields.char('Dialplan context', size=50, required=True, help="Asterisk dialplan context from which the calls will be made. Refer to /etc/asterisk/extensions.conf on your Asterisk server."), - 'wait_time': fields.integer('Wait time (sec)', required=True, help="Amount of time (in seconds) Asterisk will try to reach the user's phone before hanging up."), - 'extension_priority': fields.integer('Extension priority', required=True, help="Priority of the extension in the Asterisk dialplan. Refer to /etc/asterisk/extensions.conf on your Asterisk server."), - 'alert_info': fields.char('Alert-Info SIP header', size=255, help="Set Alert-Info header in SIP request to user's IP Phone for the click2dial feature. If empty, the Alert-Info header will not be added. You can use it to have a special ring tone for click2dial (a silent one !) or to activate auto-answer for example."), - 'number_of_digits_to_match_from_end': fields.integer('Number of digits to match from end', help='In several situations, the Asterisk-OpenERP connector will have to find a Partner in OpenERP from a phone number presented by the calling party. As the phone numbers presented by your phone operator may not always be displayed in a standard format, the best method to find the related Partner in OpenERP is to try to match the end of the phone numbers of the Partners in OpenERP with the N last digits of the phone number presented by the calling party. N is the value you should enter in this field.'), - 'company_id': fields.many2one('res.company', 'Company', help="Company who uses the Asterisk server."), + 'name': fields.char( + 'Asterisk server name', + size=50, + required=True, + help="Asterisk server name." + ), + 'active': fields.boolean( + 'Active', + help="The active field allows you to hide the Asterisk server " + "without deleting it." + ), + 'ip_address': fields.char( + 'Asterisk IP addr. or DNS', + size=50, + required=True, + help="IP address or DNS name of the Asterisk server." + ), + 'port': fields.integer( + 'Port', + required=True, + help="TCP port on which the Asterisk Manager Interface listens. " + "Defined in /etc/asterisk/manager.conf on Asterisk." + ), + 'out_prefix': fields.char( + 'Out prefix', + size=4, + help="Prefix to dial to place outgoing calls. " + "If you don't use a prefix to place outgoing calls, " + "leave empty." + ), + 'national_prefix': fields.char( + 'National prefix', + size=4, + help="Prefix for national phone calls " + "(don't include the 'out prefix'). " + "For e.g., in France, the phone numbers look like " + "'01 41 98 12 42' : the National prefix is '0'." + ), + 'international_prefix': fields.char( + 'International prefix', + required=True, + size=4, + help="Prefix to add to make international phone calls " + "(don't include the 'out prefix'). " + "For e.g., in France, the International prefix is '00'." + ), + 'country_prefix': fields.char( + 'My country prefix', + required=True, + size=4, + help="Phone prefix of the country where the Asterisk server is " + "located. For e.g. the phone prefix for France is '33'. " + "If the phone number to dial starts with the " + "'My country prefix', OpenERP will remove the country prefix " + "from the phone number and add the 'out prefix' followed by " + "the 'national prefix'. If the phone number to dial doesn't " + "start with the 'My country prefix', OpenERP will add the " + "'out prefix' followed by the 'international prefix'." + ), + 'login': fields.char( + 'AMI login', + size=30, + required=True, + help="Login that OpenERP will use to communicate with the " + "Asterisk Manager Interface. " + "Refer to /etc/asterisk/manager.conf on your Asterisk server." + ), + 'password': fields.char( + 'AMI password', + size=30, + required=True, + help="Password that Asterisk will use to communicate with the " + "Asterisk Manager Interface. " + "Refer to /etc/asterisk/manager.conf on your Asterisk server." + ), + 'context': fields.char( + 'Dialplan context', + size=50, + required=True, + help="Asterisk dialplan context from which the calls will be " + "made. Refer to /etc/asterisk/extensions.conf on your " + "Asterisk server." + ), + 'wait_time': fields.integer( + 'Wait time (sec)', + required=True, + help="Amount of time (in seconds) Asterisk will try to reach the " + "user's phone before hanging up." + ), + 'extension_priority': fields.integer( + 'Extension priority', + required=True, + help="Priority of the extension in the Asterisk dialplan. " + "Refer to /etc/asterisk/extensions.conf on your Asterisk " + "server." + ), + 'alert_info': fields.char( + 'Alert-Info SIP header', + size=255, + help="Set Alert-Info header in SIP request to user's IP Phone for " + "the click2dial feature. If empty, the Alert-Info header " + "will not be added. You can use it to have a special ring " + "tone for click2dial (a silent one !) or to activate " + "auto-answer for example." + ), + 'number_of_digits_to_match_from_end': fields.integer( + 'Number of digits to match from end', + help='In several situations, the Asterisk-OpenERP connector will ' + 'have to find a Partner in OpenERP from a phone number ' + 'presented by the calling party. As the phone numbers ' + 'presented by your phone operator may not always be ' + 'displayed in a standard format, the best method to find the ' + 'related Partner in OpenERP is to try to match the end of ' + 'the phone numbers of the Partners in OpenERP with the N ' + 'last digits of the phone number presented by the calling ' + 'party. N is the value you should enter in this field.' + ), + 'company_id': fields.many2one( + 'res.company', + 'Company', + help="Company who uses the Asterisk server." + ), } _defaults = { @@ -70,7 +180,10 @@ class asterisk_server(osv.osv): def _check_validity(self, cr, uid, ids): for server in self.browse(cr, uid, ids): country_prefix = ('Country prefix', server.country_prefix) - international_prefix = ('International prefix', server.international_prefix) + international_prefix = ( + 'International prefix', + server.international_prefix + ) out_prefix = ('Out prefix', server.out_prefix) national_prefix = ('National prefix', server.national_prefix) dialplan_context = ('Dialplan context', server.context) @@ -78,31 +191,79 @@ class asterisk_server(osv.osv): login = ('AMI login', server.login) password = ('AMI password', server.password) - for digit_prefix in [country_prefix, international_prefix, out_prefix, national_prefix]: + for digit_prefix in [ + country_prefix, + international_prefix, + out_prefix, + national_prefix + ]: if digit_prefix[1] and not digit_prefix[1].isdigit(): - raise osv.except_osv(_('Error :'), _("Only use digits for the '%s' on the Asterisk server '%s'" % (digit_prefix[0], server.name))) + raise osv.except_osv( + _('Error :'), + _("Only use digits for the '%s' on the Asterisk " + "server '%s'" % (digit_prefix[0], server.name)) + ) if server.wait_time < 1 or server.wait_time > 120: - raise osv.except_osv(_('Error :'), _("You should set a 'Wait time' value between 1 and 120 seconds for the Asterisk server '%s'" % server.name)) + raise osv.except_osv( + _('Error :'), + _("You should set a 'Wait time' value between 1 and 120 " + "seconds for the Asterisk server '%s'" % server.name) + ) if server.extension_priority < 1: - raise osv.except_osv(_('Error :'), _("The 'extension priority' must be a positive value for the Asterisk server '%s'" % server.name)) + raise osv.except_osv( + _('Error :'), + _("The 'extension priority' must be a positive value for " + "the Asterisk server '%s'" % server.name) + ) if server.port > 65535 or server.port < 1: - raise osv.except_osv(_('Error :'), _("You should set a TCP port between 1 and 65535 for the Asterisk server '%s'" % server.name)) - if server.number_of_digits_to_match_from_end > 20 or server.number_of_digits_to_match_from_end < 1: - raise osv.except_osv(_('Error :'), _("You should set a 'Number of digits to match from end' between 1 and 20 for the Asterisk server '%s'" % server.name)) - for check_string in [dialplan_context, alert_info, login, password]: + raise osv.except_osv( + _('Error :'), + _("You should set a TCP port between 1 and 65535 for the " + "Asterisk server '%s'" % server.name) + ) + if (server.number_of_digits_to_match_from_end > 20 + or server.number_of_digits_to_match_from_end < 1): + raise osv.except_osv( + _('Error :'), + _("You should set a 'Number of digits to match from end' " + "between 1 and 20 for the Asterisk server '%s'" + % server.name) + ) + for check_string in [ + dialplan_context, + alert_info, + login, + password + ]: if check_string[1]: try: - string = check_string[1].encode('ascii') + check_string[1].encode('ascii') except UnicodeEncodeError: - raise osv.except_osv(_('Error :'), _("The '%s' should only have ASCII caracters for the Asterisk server '%s'" % (check_string[0], server.name))) + raise osv.except_osv( + _('Error :'), + _("The '%s' should only have ASCII caracters for " + "the Asterisk server '%s'" + % (check_string[0], server.name)) + ) return True - _constraints = [ - (_check_validity, "Error message in raise", ['out_prefix', 'country_prefix', 'national_prefix', 'international_prefix', 'wait_time', 'extension_priority', 'port', 'context', 'alert_info', 'login', 'password', 'number_of_digits_to_match_from_end']), + (_check_validity, "Error message in raise", [ + 'out_prefix', + 'country_prefix', + 'national_prefix', + 'international_prefix', + 'wait_time', + 'extension_priority', + 'port', + 'context', + 'alert_info', + 'login', + 'password', + 'number_of_digits_to_match_from_end' + ]), ] - def _reformat_number(self, cr, uid, erp_number, ast_server, context=None): ''' This function is dedicated to the transformation of the number @@ -113,13 +274,16 @@ class asterisk_server(osv.osv): ''' error_title_msg = _("Invalid phone number") - invalid_international_format_msg = _("The phone number is not written in valid international format. Example of valid international format : +33 1 41 98 12 42") - invalid_national_format_msg = _("The phone number is not written in valid national format.") - invalid_format_msg = _("The phone number is not written in valid format.") + invalid_format_msg = _("The phone number is not written in valid " + "format.") # Let's call the variable tmp_number now tmp_number = erp_number - logger.notifyChannel('click2dial', netsvc.LOG_DEBUG, 'Number before reformat = %s' % tmp_number) + logger.notifyChannel( + 'click2dial', + netsvc.LOG_DEBUG, + 'Number before reformat = %s' % tmp_number + ) # Check if empty if not tmp_number: @@ -133,52 +297,83 @@ class asterisk_server(osv.osv): out_prefix = ast_server.out_prefix or '' # Maybe one day we will use - # phonenumbers.format_out_of_country_calling_number(phonenumbers.parse(' 5: - if ast_server.international_prefix and number[0:len(ast_server.international_prefix)] == ast_server.international_prefix: + if (ast_server.international_prefix + and number[0:len(ast_server.international_prefix)] + == ast_server.international_prefix): number = number[len(ast_server.international_prefix):] number = '+' + number - elif ast_server.national_prefix and number[0:len(ast_server.national_prefix)] == ast_server.national_prefix: + elif (ast_server.national_prefix + and number[0:len(ast_server.national_prefix)] + == ast_server.national_prefix): number = number[len(ast_server.national_prefix):] number = '+' + ast_server.country_prefix + number return number - def _get_asterisk_server_from_user(self, cr, uid, context=None): '''Returns an asterisk.server browse object''' # We check if the user has an Asterisk server configured @@ -186,15 +381,26 @@ class asterisk_server(osv.osv): if user.asterisk_server_id.id: ast_server = user.asterisk_server_id else: - asterisk_server_ids = self.search(cr, uid, [('company_id', '=', user.company_id.id)], context=context) - # If no asterisk server is configured on the user, we take the first one + asterisk_server_ids = self.search( + cr, + uid, + [('company_id', '=', user.company_id.id)], + context=context + ) + # If no asterisk server is configured on the user, + # we take the first one if not asterisk_server_ids: - raise osv.except_osv(_('Error :'), _("No Asterisk server configured for the company '%s'.") % user.company_id.name) + raise osv.except_osv( + _('Error :'), + _("No Asterisk server configured for the company '%s'.") + % user.company_id.name + ) else: - ast_server = self.browse(cr, uid, asterisk_server_ids[0], context=context) + ast_server = self.browse( + cr, uid, asterisk_server_ids[0], context=context + ) return ast_server - def _connect_to_asterisk(self, cr, uid, context=None): ''' Open the connection to the asterisk manager @@ -206,40 +412,82 @@ class asterisk_server(osv.osv): # Note : if I write 'Error' without ' :', it won't get translated... # I don't understand why ! - ast_server = self._get_asterisk_server_from_user(cr, uid, context=context) + ast_server = self._get_asterisk_server_from_user( + cr, uid, context=context + ) # We check if the current user has a chan type if not user.asterisk_chan_type: - raise osv.except_osv(_('Error :'), _('No channel type configured for the current user.')) + raise osv.except_osv( + _('Error :'), + _('No channel type configured for the current user.') + ) # We check if the current user has an internal number if not user.resource: - raise osv.except_osv(_('Error :'), _('No resource name configured for the current user')) - - - logger.notifyChannel('click2dial', netsvc.LOG_DEBUG, "User's phone : %s/%s" % (user.asterisk_chan_type, user.resource)) - logger.notifyChannel('click2dial', netsvc.LOG_DEBUG, "Asterisk server = %s:%d" % (ast_server.ip_address, ast_server.port)) + raise osv.except_osv( + _('Error :'), + _('No resource name configured for the current user') + ) + + logger.notifyChannel( + 'click2dial', + netsvc.LOG_DEBUG, + "User's phone : %s/%s" % (user.asterisk_chan_type, user.resource) + ) + logger.notifyChannel( + 'click2dial', + netsvc.LOG_DEBUG, + "Asterisk server = %s:%d" + % (ast_server.ip_address, ast_server.port) + ) # Connect to the Asterisk Manager Interface try: - ast_manager = Manager.Manager((ast_server.ip_address, ast_server.port), ast_server.login, ast_server.password) + ast_manager = Manager.Manager( + (ast_server.ip_address, ast_server.port), + ast_server.login, + ast_server.password + ) except Exception, e: - logger.notifyChannel('click2dial', netsvc.LOG_ERROR, "Error in the Originate request to Asterisk server %s" % ast_server.ip_address) - logger.notifyChannel('click2dial', netsvc.LOG_ERROR, "Here is the detail of the error : '%s'" % unicode(e)) - raise osv.except_osv(_('Error :'), _("Problem in the request from OpenERP to Asterisk. Here is the detail of the error: '%s'" % unicode(e))) - return False + logger.notifyChannel( + 'click2dial', + netsvc.LOG_ERROR, + "Error in the Originate request to Asterisk server %s" + % ast_server.ip_address + ) + logger.notifyChannel( + 'click2dial', + netsvc.LOG_ERROR, + "Here is the detail of the error : '%s'" % unicode(e) + ) + raise osv.except_osv( + _('Error :'), + _("Problem in the request from OpenERP to Asterisk. Here is " + "the detail of the error: '%s'" % unicode(e)) + ) return (user, ast_server, ast_manager) def _dial_with_asterisk(self, cr, uid, erp_number, context=None): if not erp_number: - raise osv.except_osv(_('Error :'), "Hara kiri : you must call the function with erp_number") - - user, ast_server, ast_manager = self._connect_to_asterisk(cr, uid, context=context) - ast_number = self._reformat_number(cr, uid, erp_number, ast_server, context=context) + raise osv.except_osv( + _('Error :'), + "Hara kiri : you must call the function with erp_number" + ) + + user, ast_server, ast_manager = self._connect_to_asterisk( + cr, uid, context=context + ) + ast_number = self._reformat_number( + cr, uid, erp_number, ast_server, context=context + ) # The user should have a CallerID if not user.callerid: - raise osv.except_osv(_('Error :'), _('No callerID configured for the current user')) + raise osv.except_osv( + _('Error :'), + _('No callerID configured for the current user') + ) variable = [] if user.asterisk_chan_type == 'SIP': @@ -247,24 +495,40 @@ class asterisk_server(osv.osv): if user.alert_info: variable.append('SIPAddHeader=Alert-Info: ' + user.alert_info) elif ast_server.alert_info: - variable.append('SIPAddHeader=Alert-Info: ' + ast_server.alert_info) + variable.append( + 'SIPAddHeader=Alert-Info: ' + ast_server.alert_info + ) if user.variable: for user_variable in user.variable.split('|'): variable.append(user_variable.strip()) try: ast_manager.Originate( - user.asterisk_chan_type + '/' + user.resource + ( ('/' + user.dial_suffix) if user.dial_suffix else ''), - context = ast_server.context, - extension = ast_number, - priority = str(ast_server.extension_priority), - timeout = str(ast_server.wait_time*1000), - caller_id = user.callerid, - variable = variable) + user.asterisk_chan_type + '/' + user.resource + + (('/' + user.dial_suffix) if user.dial_suffix else ''), + context=ast_server.context, + extension=ast_number, + priority=str(ast_server.extension_priority), + timeout=str(ast_server.wait_time * 1000), + caller_id=user.callerid, + variable=variable) except Exception, e: - logger.notifyChannel('click2dial', netsvc.LOG_ERROR, "Error in the Originate request to Asterisk server %s" % ast_server.ip_address) - logger.notifyChannel('click2dial', netsvc.LOG_ERROR, "Here is the detail of the error : '%s'" % unicode(e)) - raise osv.except_osv(_('Error :'), _("Click to dial with Asterisk failed.\nHere is the error: '%s'" % unicode(e))) + logger.notifyChannel( + 'click2dial', + netsvc.LOG_ERROR, + "Error in the Originate request to Asterisk server %s" + % ast_server.ip_address + ) + logger.notifyChannel( + 'click2dial', + netsvc.LOG_ERROR, + "Here is the detail of the error : '%s'" % unicode(e) + ) + raise osv.except_osv( + _('Error :'), + _("Click to dial with Asterisk failed.\n" + "Here is the error: '%s'" % unicode(e)) + ) finally: ast_manager.Logoff() @@ -273,32 +537,66 @@ class asterisk_server(osv.osv): def _get_calling_number(self, cr, uid, context=None): - user, ast_server, ast_manager = self._connect_to_asterisk(cr, uid, context=context) + user, ast_server, ast_manager = self._connect_to_asterisk( + cr, uid, context=context + ) calling_party_number = False try: list_chan = ast_manager.Status() - #from pprint import pprint - #pprint(list_chan) - logger.notifyChannel('click2dial', netsvc.LOG_DEBUG, "Result of Status AMI request: %s"% list_chan) + # from pprint import pprint + # pprint(list_chan) + logger.notifyChannel( + 'click2dial', + netsvc.LOG_DEBUG, + "Result of Status AMI request: %s" % list_chan + ) for chan in list_chan.values(): sip_account = user.asterisk_chan_type + '/' + user.resource - if chan.get('ChannelState') == '4' and chan.get('ConnectedLineNum') == user.internal_number: # 4 = Ring - logger.notifyChannel('click2dial', netsvc.LOG_DEBUG, "Found a matching Event in 'Ring' state") + if (chan.get('ChannelState') == '4' # 4 = Ring + and chan.get('ConnectedLineNum') + == user.internal_number): + logger.notifyChannel( + 'click2dial', + netsvc.LOG_DEBUG, + "Found a matching Event in 'Ring' state" + ) calling_party_number = chan.get('CallerIDNum') break - if chan.get('ChannelState') == '6' and sip_account in chan.get('BridgedChannel'): # 6 = Up - logger.notifyChannel('click2dial', netsvc.LOG_DEBUG, "Found a matching Event in 'Up' state") + if (chan.get('ChannelState') == '6' # 6 = Up + and sip_account in chan.get('BridgedChannel')): + logger.notifyChannel( + 'click2dial', + netsvc.LOG_DEBUG, + "Found a matching Event in 'Up' state" + ) calling_party_number = chan.get('CallerIDNum') break except Exception, e: - logger.notifyChannel('click2dial', netsvc.LOG_ERROR, "Error in the Status request to Asterisk server %s" % ast_server.ip_address) - logger.notifyChannel('click2dial', netsvc.LOG_ERROR, "Here is the detail of the error : '%s'" % unicode(e)) - raise osv.except_osv(_('Error :'), _("Can't get calling number from Asterisk.\nHere is the error: '%s'" % unicode(e))) + logger.notifyChannel( + 'click2dial', + netsvc.LOG_ERROR, + "Error in the Status request to Asterisk server %s" + % ast_server.ip_address + ) + logger.notifyChannel( + 'click2dial', + netsvc.LOG_ERROR, + "Here is the detail of the error : '%s'" % unicode(e) + ) + raise osv.except_osv( + _('Error :'), + _("Can't get calling number from Asterisk.\n" + "Here is the error: '%s'" % unicode(e)) + ) finally: ast_manager.Logoff() - logger.notifyChannel('click2dial', netsvc.LOG_DEBUG, "The calling party number is '%s'" % calling_party_number) + logger.notifyChannel( + 'click2dial', + netsvc.LOG_DEBUG, + "The calling party number is '%s'" % calling_party_number + ) return calling_party_number @@ -311,33 +609,76 @@ class res_users(osv.osv): _inherit = "res.users" _columns = { - 'internal_number': fields.char('Internal number', size=15, - help="User's internal phone number."), - 'dial_suffix': fields.char('User-specific dial suffix', size=15, - help="User-specific dial suffix such as aa=2wb for SCCP auto answer."), - 'callerid': fields.char('Caller ID', size=50, - help="Caller ID used for the calls initiated by this user."), - # You'd probably think : Asterisk should reuse the callerID of sip.conf ! - # But it cannot, cf http://lists.digium.com/pipermail/asterisk-users/2012-January/269787.html - 'asterisk_chan_type': fields.selection([ - ('SIP', 'SIP'), - ('IAX2', 'IAX2'), - ('DAHDI', 'DAHDI'), - ('Zap', 'Zap'), - ('Skinny', 'Skinny'), - ('MGCP', 'MGCP'), - ('mISDN', 'mISDN'), - ('H323', 'H323'), - ('SCCP', 'SCCP'), - ], 'Asterisk channel type', - help="Asterisk channel type, as used in the Asterisk dialplan. If the user has a regular IP phone, the channel type is 'SIP'."), - 'resource': fields.char('Resource name', size=64, - help="Resource name for the channel type selected. For example, if you use 'Dial(SIP/phone1)' in your Asterisk dialplan to ring the SIP phone of this user, then the resource name for this user is 'phone1'. For a SIP phone, the phone number is often used as resource name, but not always."), - 'alert_info': fields.char('User-specific Alert-Info SIP header', size=255, help="Set a user-specific Alert-Info header in SIP request to user's IP Phone for the click2dial feature. If empty, the Alert-Info header will not be added. You can use it to have a special ring tone for click2dial (a silent one !) or to activate auto-answer for example."), - 'variable': fields.char('User-specific Variable', size=255, help="Set a user-specific 'Variable' field in the Asterisk Manager Interface 'originate' request for the click2dial feature. If you want to have several variable headers, separate them with '|'."), - 'asterisk_server_id': fields.many2one('asterisk.server', 'Asterisk server', - help="Asterisk server on which the user's phone is connected. If you leave this field empty, it will use the first Asterisk server of the user's company."), - } + 'internal_number': fields.char( + 'Internal number', + size=15, + help="User's internal phone number." + ), + 'dial_suffix': fields.char( + 'User-specific dial suffix', + size=15, + help="User-specific dial suffix such as aa=2wb for SCCP auto " + "answer." + ), + 'callerid': fields.char( + 'Caller ID', + size=50, + help="Caller ID used for the calls initiated by this user." + ), + # You'd probably think: Asterisk should reuse the callerID of sip.conf! + # But it cannot, cf + # lists.digium.com/pipermail/asterisk-users/2012-January/269787.html + 'asterisk_chan_type': fields.selection( + [ + ('SIP', 'SIP'), + ('IAX2', 'IAX2'), + ('DAHDI', 'DAHDI'), + ('Zap', 'Zap'), + ('Skinny', 'Skinny'), + ('MGCP', 'MGCP'), + ('mISDN', 'mISDN'), + ('H323', 'H323'), + ('SCCP', 'SCCP'), + ], + 'Asterisk channel type', + help="Asterisk channel type, as used in the Asterisk dialplan. " + "If the user has a regular IP phone, the channel type is " + "'SIP'." + ), + 'resource': fields.char( + 'Resource name', + size=64, + help="Resource name for the channel type selected. For example, " + "if you use 'Dial(SIP/phone1)' in your Asterisk dialplan to " + "ring the SIP phone of this user, then the resource name for " + "this user is 'phone1'. For a SIP phone, the phone number " + "is often used as resource name, but not always." + ), + 'alert_info': fields.char( + 'User-specific Alert-Info SIP header', + size=255, + help="Set a user-specific Alert-Info header in SIP request to " + "user's IP Phone for the click2dial feature. If empty, the " + "Alert-Info header will not be added. You can use it to have " + "a special ring tone for click2dial (a silent one !) or to " + "activate auto-answer for example." + ), + 'variable': fields.char( + 'User-specific Variable', + size=255, + help="Set a user-specific 'Variable' field in the Asterisk " + "Manager Interface 'originate' request for the click2dial " + "feature. If you want to have several variable headers, " + "separate them with '|'." + ), + 'asterisk_server_id': fields.many2one( + 'asterisk.server', + 'Asterisk server', + help="Asterisk server on which the user's phone is connected. " + "If you leave this field empty, it will use the first " + "Asterisk server of the user's company." + ), + } _defaults = { 'asterisk_chan_type': lambda *a: 'SIP', @@ -345,16 +686,28 @@ class res_users(osv.osv): def _check_validity(self, cr, uid, ids): for user in self.browse(cr, uid, ids): - for check_string in [('Resource name', user.resource), ('Internal number', user.internal_number), ('Caller ID', user.callerid)]: + for check_string in [ + ('Resource name', user.resource), + ('Internal number', user.internal_number), + ('Caller ID', user.callerid) + ]: if check_string[1]: try: - plom = check_string[1].encode('ascii') + check_string[1].encode('ascii') except UnicodeEncodeError: - raise osv.except_osv(_('Error :'), _("The '%s' for the user '%s' should only have ASCII caracters" % (check_string[0], user.name))) + raise osv.except_osv( + _('Error :'), + _("The '%s' for the user '%s' should only have " + "ASCII caracters" % (check_string[0], user.name)) + ) return True _constraints = [ - (_check_validity, "Error message in raise", ['resource', 'internal_number', 'callerid']), + (_check_validity, "Error message in raise", [ + 'resource', + 'internal_number', + 'callerid' + ]), ] res_users() @@ -363,147 +716,288 @@ res_users() class res_partner_address(osv.osv): _inherit = "res.partner.address" - - def _format_phonenumber_to_e164(self, cr, uid, ids, name, arg, context=None): + def _format_phonenumber_to_e164(self, cr, uid, ids, name, arg, + context=None): result = {} - for addr in self.read(cr, uid, ids, ['phone', 'mobile', 'fax'], context=context): + for addr in self.read(cr, uid, ids, ['phone', 'mobile', 'fax'], + context=context): result[addr['id']] = {} - for fromfield, tofield in [('phone', 'phone_e164'), ('mobile', 'mobile_e164'), ('fax', 'fax_e164')]: + for fromfield, tofield in [ + ('phone', 'phone_e164'), + ('mobile', 'mobile_e164'), + ('fax', 'fax_e164') + ]: if not addr.get(fromfield): res = False else: try: - res = phonenumbers.format_number(phonenumbers.parse(addr.get(fromfield), None), phonenumbers.PhoneNumberFormat.E164) + res = phonenumbers.format_number( + phonenumbers.parse(addr.get(fromfield), None), + phonenumbers.PhoneNumberFormat.E164 + ) except Exception, e: - logger.notifyChannel('click2dial', netsvc.LOG_ERROR, "Cannot reformat the phone number '%s' to E.164 format. Error message: %s" % (addr.get(fromfield), e)) - logger.notifyChannel('click2dial', netsvc.LOG_ERROR, "You should fix this number and run the wizard 'Reformat all phone numbers' from the menu Settings > Configuration > Asterisk") - # If I raise an exception here, it won't be possible to install - # the module on a DB with bad phone numbers - #raise osv.except_osv(_('Error :'), _("Cannot reformat the phone number '%s' to E.164 format. Error message: %s" % (addr.get(fromfield), e))) + logger.notifyChannel( + 'click2dial', + netsvc.LOG_ERROR, + "Cannot reformat the phone number '%s' to E.164 " + "format. Error message: %s" + % (addr.get(fromfield), e) + ) + logger.notifyChannel( + 'click2dial', + netsvc.LOG_ERROR, + "You should fix this number and run the wizard " + "'Reformat all phone numbers' from the menu " + "Settings > Configuration > Asterisk" + ) + # If I raise an exception here, it won't be possible to + # install the module on a DB with bad phone numbers res = False result[addr['id']][tofield] = res - #print "RESULT _format_phonenumber_to_e164", result return result - _columns = { - 'phone_e164': fields.function(_format_phonenumber_to_e164, type='char', size=64, string='Phone in E.164 format', method=True, readonly=True, multi="e164", store={ - 'res.partner.address': (lambda self, cr, uid, ids, c={}: ids, ['phone'], 10), - }), - 'mobile_e164': fields.function(_format_phonenumber_to_e164, type='char', size=64, string='Mobile in E.164 format', method=True, readonly=True, multi="e164", store={ - 'res.partner.address': (lambda self, cr, uid, ids, c={}: ids, ['mobile'], 10), - }), - 'fax_e164': fields.function(_format_phonenumber_to_e164, type='char', size=64, string='Fax in E.164 format', method=True, readonly=True, multi="e164", store={ - 'res.partner.address': (lambda self, cr, uid, ids, c={}: ids, ['fax'], 10), - }), - } + 'phone_e164': fields.function( + _format_phonenumber_to_e164, + type='char', + size=64, + string='Phone in E.164 format', + method=True, + readonly=True, + multi="e164", + store={ + 'res.partner.address': (lambda self, cr, uid, ids, c=None: + ids, ['phone'], 10), + } + ), + 'mobile_e164': fields.function( + _format_phonenumber_to_e164, + type='char', + size=64, + string='Mobile in E.164 format', + method=True, + readonly=True, + multi="e164", + store={ + 'res.partner.address': (lambda self, cr, uid, ids, c=None: + ids, ['mobile'], 10), + } + ), + 'fax_e164': fields.function( + _format_phonenumber_to_e164, + type='char', + size=64, + string='Fax in E.164 format', + method=True, + readonly=True, + multi="e164", + store={ + 'res.partner.address': (lambda self, cr, uid, ids, c=None: + ids, ['fax'], 10), + } + ), + } def _reformat_phonenumbers(self, cr, uid, vals, context=None): """Reformat phone numbers in international format i.e. +33141981242""" phonefields = ['phone', 'fax', 'mobile'] if any([vals.get(field) for field in phonefields]): - user = self.pool.get('res.users').browse(cr, uid, uid, context=context) + user = self.pool.get('res.users').browse( + cr, uid, uid, context=context + ) # country_id on res.company is a fields.function that looks at # company_id.partner_id.addres(default).country_id if user.company_id.partner_id.country: user_countrycode = user.company_id.partner_id.country.code else: - # We need to raise an exception here because, if we pass None as second arg of phonenumbers.parse(), it will raise an exception when you try to enter a phone number in national format... so it's better to raise the exception here - raise osv.except_osv(_('Error :'), _("You should set a country on the company '%s'" % user.company_id.name)) - #print "user_countrycode=", user_countrycode + # We need to raise an exception here because, if we pass None + # as second arg of phonenumbers.parse(), it will raise an + # exception when you try to enter a phone number in national + # format... so it's better to raise the exception here + raise osv.except_osv( + _('Error :'), + _("You should set a country on the company '%s'" + % user.company_id.name) + ) for field in phonefields: if vals.get(field): try: - res_parse = phonenumbers.parse(vals.get(field), user_countrycode) + res_parse = phonenumbers.parse( + vals.get(field), + user_countrycode + ) except Exception, e: - raise osv.except_osv(_('Error :'), _("Cannot reformat the phone number '%s' to international format. Error message: %s" % (vals.get(field), e))) - #print "res_parse=", res_parse - vals[field] = phonenumbers.format_number(res_parse, phonenumbers.PhoneNumberFormat.INTERNATIONAL) + raise osv.except_osv( + _('Error :'), + _("Cannot reformat the phone number '%s' to " + "international format. Error message: %s" + % (vals.get(field), e)) + ) + vals[field] = phonenumbers.format_number( + res_parse, + phonenumbers.PhoneNumberFormat.INTERNATIONAL + ) return vals - def create(self, cr, uid, vals, context=None): - vals_reformated = self._reformat_phonenumbers(cr, uid, vals, context=context) - return super(res_partner_address, self).create(cr, uid, vals_reformated, context=context) - + vals_reformated = self._reformat_phonenumbers( + cr, uid, vals, context=context + ) + return super(res_partner_address, self).create( + cr, uid, vals_reformated, context=context + ) def write(self, cr, uid, ids, vals, context=None): - vals_reformated = self._reformat_phonenumbers(cr, uid, vals, context=context) - return super(res_partner_address, self).write(cr, uid, ids, vals_reformated, context=context) - - - def dial(self, cr, uid, ids, phone_field=['phone', 'phone_e164'], context=None): - '''Read the number to dial and call _connect_to_asterisk the right way''' - erp_number_read = self.read(cr, uid, ids[0], phone_field, context=context) + vals_reformated = self._reformat_phonenumbers( + cr, uid, vals, context=context + ) + return super(res_partner_address, self).write( + cr, uid, ids, vals_reformated, context=context + ) + + def dial(self, cr, uid, ids, phone_field=None, context=None): + """Read the number to dial and call _connect_to_asterisk the + right way + """ + if phone_field is None: + phone_field = ['phone', 'phone_e164'] + erp_number_read = self.read( + cr, uid, ids[0], phone_field, context=context + ) erp_number_e164 = erp_number_read[phone_field[1]] erp_number_display = erp_number_read[phone_field[0]] # Check if the number to dial is not empty if not erp_number_display: raise osv.except_osv(_('Error :'), _('There is no phone number !')) elif erp_number_display and not erp_number_e164: - raise osv.except_osv(_('Error :'), _("The phone number isn't stored in the standard E.164 format. Try to run the wizard 'Reformat all phone numbers' from the menu Settings > Configuration > Asterisk.")) - return self.pool.get('asterisk.server')._dial_with_asterisk(cr, uid, erp_number_e164, context=context) - + raise osv.except_osv( + _('Error :'), + _("The phone number isn't stored in the standard E.164 " + "format. Try to run the wizard 'Reformat all phone numbers' " + "from the menu Settings > Configuration > Asterisk.") + ) + return self.pool.get('asterisk.server')._dial_with_asterisk( + cr, uid, erp_number_e164, context=context + ) def action_dial_phone(self, cr, uid, ids, context=None): - '''Function called by the button 'Dial' next to the 'phone' field - in the partner address view''' - return self.dial(cr, uid, ids, phone_field=['phone', 'phone_e164'], context=context) - + """Function called by the button 'Dial' next to the 'phone' field + in the partner address view + """ + return self.dial( + cr, uid, ids, phone_field=['phone', 'phone_e164'], context=context + ) def action_dial_mobile(self, cr, uid, ids, context=None): - '''Function called by the button 'Dial' next to the 'mobile' field - in the partner address view''' - return self.dial(cr, uid, ids, phone_field=['mobile', 'mobile_e164'], context=context) - + """Function called by the button 'Dial' next to the 'mobile' field + in the partner address view + """ + return self.dial( + cr, uid, ids, phone_field=['mobile', 'mobile_e164'], + context=context + ) def get_name_from_phone_number(self, cr, uid, number, context=None): - '''Function to get name from phone number. Usefull for use from Asterisk + """Function to get name from phone number. Useful for use from Asterisk to add CallerID name to incoming calls. - The "scripts/" subdirectory of this module has an AGI script that you can - install on your Asterisk IPBX : the script will be called from the Asterisk - dialplan via the AGI() function and it will use this function via an XML-RPC - request. - ''' - res = self.get_partner_from_phone_number(cr, uid, number, context=context) + The "scripts/" subdirectory of this module has an AGI script that you + can install on your Asterisk IPBX : the script will be called from the + Asterisk dialplan via the AGI() function and it will use this function + via an XML-RPC request. + """ + res = self.get_partner_from_phone_number( + cr, uid, number, context=context + ) if res: return res[2] else: return False - - def get_partner_from_phone_number(self, cr, uid, presented_number, context=None): + def get_partner_from_phone_number(self, cr, uid, presented_number, + context=None): # We check that "presented_number" is really a number - logger.notifyChannel('click2dial', netsvc.LOG_DEBUG, u"Call get_name_from_phone_number with number = %s" % presented_number) + logger.notifyChannel( + 'click2dial', + netsvc.LOG_DEBUG, + u"Call get_name_from_phone_number with number = %s" + % presented_number + ) if not isinstance(presented_number, (str, unicode)): - logger.notifyChannel('click2dial', netsvc.LOG_WARNING, u"Number '%s' should be a 'str' or 'unicode' but it is a '%s'" % (presented_number, type(presented_number))) + logger.notifyChannel( + 'click2dial', + netsvc.LOG_WARNING, + u"Number '%s' should be a 'str' or 'unicode' but it is a '%s'" + % (presented_number, type(presented_number)) + ) return False if not presented_number.isdigit(): - logger.notifyChannel('click2dial', netsvc.LOG_WARNING, u"Number '%s' should only contain digits." % presented_number) + logger.notifyChannel( + 'click2dial', + netsvc.LOG_WARNING, + u"Number '%s' should only contain digits." % presented_number + ) return False - ast_server = self.pool.get('asterisk.server')._get_asterisk_server_from_user(cr, uid, context=context) - nr_digits_to_match_from_end = ast_server.number_of_digits_to_match_from_end + ast_server_obj = self.pool.get('asterisk.server') + ast_server = ast_server_obj._get_asterisk_server_from_user( + cr, uid, context=context + ) + nr_digits_to_match_from_end = ( + ast_server.number_of_digits_to_match_from_end + ) if len(presented_number) >= nr_digits_to_match_from_end: - end_number_to_match = presented_number[-nr_digits_to_match_from_end:len(presented_number)] + end_number_to_match = presented_number[ + -nr_digits_to_match_from_end:len(presented_number) + ] else: end_number_to_match = presented_number - logger.notifyChannel('click2dial', netsvc.LOG_DEBUG, "Will search phone and mobile numbers in res.partner ending with '%s'" % end_number_to_match) + logger.notifyChannel( + 'click2dial', + netsvc.LOG_DEBUG, + "Will search phone and mobile numbers in res.partner ending with " + "'%s'" % end_number_to_match + ) # We try to match a phone or mobile number with the same end pg_seach_number = str('%' + end_number_to_match) - res_ids = self.search(cr, uid, ['|', ('phone_e164', 'ilike', pg_seach_number), ('mobile_e164', 'ilike', pg_seach_number)], context=context) + res_ids = self.search(cr, uid, [ + '|', + ('phone_e164', 'ilike', pg_seach_number), + ('mobile_e164', 'ilike', pg_seach_number) + ], context=context) # TODO : use is_number_match() of the phonenumber lib ? if len(res_ids) > 1: - logger.notifyChannel('click2dial', netsvc.LOG_WARNING, u"There are several partners addresses (IDS = %s) with a phone number ending with '%s'" % (str(res_ids), end_number_to_match)) + logger.notifyChannel( + 'click2dial', + netsvc.LOG_WARNING, + u"There are several partners addresses (IDS = %s) with a " + u"phone number ending with '%s'" + % (str(res_ids), end_number_to_match) + ) if res_ids: - entry = self.read(cr, uid, res_ids[0], ['name', 'partner_id'], context=context) - logger.notifyChannel('click2dial', netsvc.LOG_DEBUG, u"Answer get_partner_from_phone_number with name = %s" % entry['name']) - return (entry['id'], entry['partner_id'] and entry['partner_id'][0] or False, entry['name']) + entry = self.read( + cr, uid, res_ids[0], ['name', 'partner_id'], context=context + ) + logger.notifyChannel( + 'click2dial', + netsvc.LOG_DEBUG, + u"Answer get_partner_from_phone_number with name = %s" + % entry['name'] + ) + return ( + entry['id'], + entry['partner_id'] + and entry['partner_id'][0] + or False, entry['name'] + ) else: - logger.notifyChannel('click2dial', netsvc.LOG_DEBUG, u"No match for end of phone number '%s'" % end_number_to_match) + logger.notifyChannel( + 'click2dial', + netsvc.LOG_DEBUG, + u"No match for end of phone number '%s'" % end_number_to_match + ) return False res_partner_address() @@ -514,7 +1008,12 @@ class res_company(osv.osv): _inherit = "res.company" _columns = { - 'asterisk_server_ids': fields.one2many('asterisk.server', 'company_id', 'Asterisk servers', help="List of Asterisk servers.") + 'asterisk_server_ids': fields.one2many( + 'asterisk.server', + 'company_id', + 'Asterisk servers', + help="List of Asterisk servers." + ) } res_company() diff --git a/asterisk_click2dial/scripts/get_cid_name.py b/asterisk_click2dial/scripts/get_cid_name.py index 88f64b8..6329c3d 100755 --- a/asterisk_click2dial/scripts/get_cid_name.py +++ b/asterisk_click2dial/scripts/get_cid_name.py @@ -5,9 +5,10 @@ When executed from the dialplan on an incoming phone call, it will lookup in OpenERP's partners, and, if it finds the phone number, it will get the - corresponding name of the person and use this name as CallerID name for the incoming call. + corresponding name of the person and use this name as CallerID name for the + incoming call. - Requires the "asterisk_click2dial" module + Requires the "asterisk_click2dial" module available from https://code.launchpad.net/openerp-asterisk-connector for OpenERP version >= 5.0 @@ -36,8 +37,9 @@ This user only needs to be part of the group "Asterisk CallerID", which has read access on the 'res.partner.address' object, nothing more. - Note that this script can be used without OpenERP, with just the geolocalisation - feature : for that, don't use option --server ; only use --geoloc + Note that this script can be used without OpenERP, with just the + geolocalisation feature : for that, don't use option --server ; only use + --geoloc """ __author__ = "Alexis de Lattre " @@ -69,18 +71,103 @@ from optparse import OptionParser default_cid_name = "Not in OpenERP" # Define command line options -option_server = {'names': ('-s', '--server'), 'dest': 'server', 'type': 'string', 'help': 'DNS or IP address of the OpenERP server. Default = none (will not try to connect to OpenERP)', 'action': 'store', 'default': False} -option_port = {'names': ('-p', '--port'), 'dest': 'port', 'type': 'int', 'help': "Port of OpenERP's XML-RPC interface. Default = 8069", 'action': 'store', 'default': 8069} -option_ssl = {'names': ('-e', '--ssl'), 'dest': 'ssl', 'help': "Use XML-RPC secure i.e. with SSL instead of clear XML-RPC. Default = no, use clear XML-RPC", 'action': 'store_true', 'default': False} -option_database = {'names': ('-d', '--database'), 'dest': 'database', 'type': 'string', 'help': "OpenERP database name. Default = 'openerp'", 'action': 'store', 'default': 'openerp'} -option_user = {'names': ('-u', '--user-id'), 'dest': 'user', 'type': 'int', 'help': "OpenERP user ID to use when connecting to OpenERP. Default = 2", 'action': 'store', 'default': 2} -option_password = {'names': ('-w', '--password'), 'dest': 'password', 'type': 'string', 'help': "Password of the OpenERP user. Default = 'demo'", 'action': 'store', 'default': 'demo'} -option_ascii = {'names': ('-a', '--ascii'), 'dest': 'ascii', 'help': "Convert name from UTF-8 to ASCII. Default = no, keep UTF-8", 'action': 'store_true', 'default': False} -option_geoloc = {'names': ('-g', '--geoloc'), 'dest': 'geoloc', 'help': "Try to geolocate phone numbers unknown to OpenERP. This features requires the 'phonenumbers' Python lib. To install it, run 'sudo pip install phonenumbers' Default = no", 'action': 'store_true', 'default': False} -option_geoloc_lang = {'names': ('-l', '--geoloc-lang'), 'dest': 'lang', 'help': "Language in which the name of the country and city name will be displayed by the geolocalisation database. Use the 2 letters ISO code of the language. Default = 'en'", 'action': 'store', 'default': "en"} -option_geoloc_country = {'names': ('-c', '--geoloc-country'), 'dest': 'country', 'help': "2 letters ISO code for your country e.g. 'FR' for France. This will be used by the geolocalisation system to parse the phone number of the calling party. Default = 'FR'", 'action': 'store', 'default': "FR"} - -options = [option_server, option_port, option_ssl, option_database, option_user, option_password, option_ascii, option_geoloc, option_geoloc_lang, option_geoloc_country] +option_server = { + 'names': ('-s', '--server'), + 'dest': 'server', + 'type': 'string', + 'help': 'DNS or IP address of the OpenERP server. Default = none ' + '(will not try to connect to OpenERP)', + 'action': 'store', + 'default': False, +} +option_port = { + 'names': ('-p', '--port'), + 'dest': 'port', + 'type': 'int', + 'help': "Port of OpenERP's XML-RPC interface. Default = 8069", + 'action': 'store', + 'default': 8069, +} +option_ssl = { + 'names': ('-e', '--ssl'), + 'dest': 'ssl', + 'help': "Use XML-RPC secure i.e. with SSL instead of clear XML-RPC. " + "Default = no, use clear XML-RPC", + 'action': 'store_true', + 'default': False, +} +option_database = { + 'names': ('-d', '--database'), + 'dest': 'database', + 'type': 'string', + 'help': "OpenERP database name. Default = 'openerp'", + 'action': 'store', + 'default': 'openerp', +} +option_user = { + 'names': ('-u', '--user-id'), + 'dest': 'user', + 'type': 'int', + 'help': "OpenERP user ID to use when connecting to OpenERP. Default = 2", + 'action': 'store', + 'default': 2, +} +option_password = { + 'names': ('-w', '--password'), + 'dest': 'password', + 'type': 'string', + 'help': "Password of the OpenERP user. Default = 'demo'", + 'action': 'store', + 'default': 'demo', +} +option_ascii = { + 'names': ('-a', '--ascii'), + 'dest': 'ascii', + 'help': "Convert name from UTF-8 to ASCII. Default = no, keep UTF-8", + 'action': 'store_true', + 'default': False, +} +option_geoloc = { + 'names': ('-g', '--geoloc'), + 'dest': 'geoloc', + 'help': "Try to geolocate phone numbers unknown to OpenERP. This features " + "requires the 'phonenumbers' Python lib. To install it, run " + "'sudo pip install phonenumbers' Default = no", + 'action': 'store_true', + 'default': False, +} +option_geoloc_lang = { + 'names': ('-l', '--geoloc-lang'), + 'dest': 'lang', + 'help': "Language in which the name of the country and city name will be " + "displayed by the geolocalisation database. Use the 2 letters ISO " + "code of the language. Default = 'en'", + 'action': 'store', + 'default': "en", +} +option_geoloc_country = { + 'names': ('-c', '--geoloc-country'), + 'dest': 'country', + 'help': "2 letters ISO code for your country e.g. 'FR' for France. This " + "will be used by the geolocalisation system to parse the phone " + "number of the calling party. Default = 'FR'", + 'action': 'store', + 'default': "FR", +} + +options = [ + option_server, + option_port, + option_ssl, + option_database, + option_user, + option_password, + option_ascii, + option_geoloc, + option_geoloc_lang, + option_geoloc_country, +] + def stdout_write(string): '''Wrapper on sys.stdout.write''' @@ -89,51 +176,62 @@ def stdout_write(string): # When we output a command, we get an answer "200 result=1" on stdin # Purge stdin to avoid these Asterisk error messages : # utils.c ast_carefulwrite: write() returned error: Broken pipe - input_line = sys.stdin.readline() + sys.stdin.readline() return True + def stderr_write(string): '''Wrapper on sys.stderr.write''' sys.stderr.write(string.encode(sys.stdout.encoding or 'utf-8', 'replace')) sys.stdout.flush() return True + def geolocate_phone_number(number, my_country_code, lang): import phonenumbers import phonenumbers.geocoder res = '' phonenum = phonenumbers.parse(number, my_country_code.upper()) city = phonenumbers.area_description_for_number(phonenum, lang.lower()) - #country = phonenumbers.country_name_for_number(phonenum, lang.lower()) + # country = phonenumbers.country_name_for_number(phonenum, lang.lower()) country_code = phonenumbers.region_code_for_number(phonenum) if country_code == my_country_code.upper(): - # We don't display the country name when it's my own country + # We don't display the country name when it's my own country if city: res = city else: # Convert country code to country name - country = phonenumbers.geocoder._region_display_name(country_code, lang.lower()) + country = phonenumbers.geocoder._region_display_name( + country_code, lang.lower() + ) if country and city: res = country + ' ' + city elif country and not city: res = country return res + def convert_to_ascii(my_unicode): - '''Convert to ascii, with clever management of accents (é -> e, è -> e)''' + """Convert to ascii, with clever management of accents (é -> e, è -> e)""" import unicodedata if isinstance(my_unicode, unicode): - my_unicode_with_ascii_chars_only = ''.join((char for char in unicodedata.normalize('NFD', my_unicode) if unicodedata.category(char) != 'Mn')) + my_unicode_with_ascii_chars_only = ''.join( + (char + for char in unicodedata.normalize('NFD', my_unicode) + if unicodedata.category(char) != 'Mn') + ) return str(my_unicode_with_ascii_chars_only) - # If the argument is already of string type, we return it with the same value + # If the argument is already of string type, we return it with the same + # value elif isinstance(my_unicode, str): return my_unicode else: return False + def main(options, arguments): - #print 'options = %s' % options - #print 'arguments = %s' % arguments + # print 'options = %s' % options + # print 'arguments = %s' % arguments # AGI passes parameters to the script on standard input stdinput = {} @@ -145,8 +243,8 @@ def main(options, arguments): try: variable, value = line.split(':') except: - break - if variable[:4] != 'agi_': # All AGI parameters start with 'agi_' + break + if variable[:4] != 'agi_': # All AGI parameters start with 'agi_' stderr_write("bad stdin variable : %s\n" % variable) continue variable = variable.strip() @@ -161,8 +259,12 @@ def main(options, arguments): # If we already have a "True" caller ID name # i.e. not just digits, but a real name, then we don't try to # connect to OpenERP or geoloc, we just keep it - if stdinput.get('agi_calleridname') and not stdinput.get('agi_calleridname').isdigit() and stdinput.get('agi_calleridname').lower() not in ['asterisk', 'unknown', 'anonymous']: - stdout_write('VERBOSE "Incoming CallerID name is %s"\n' % stdinput.get('agi_calleridname')) + if (stdinput.get('agi_calleridname') + and not stdinput.get('agi_calleridname').isdigit() + and stdinput.get('agi_calleridname').lower() + not in ['asterisk', 'unknown', 'anonymous']): + stdout_write('VERBOSE "Incoming CallerID name is %s"\n' + % stdinput.get('agi_calleridname')) stdout_write('VERBOSE "As it is a real name, we do not change it"\n') return True @@ -175,24 +277,42 @@ def main(options, arguments): # Match for particular cases and anonymous phone calls # To test anonymous call in France, dial 3651 + number if not input_cid_number.isdigit(): - stdout_write('VERBOSE "CallerID number (%s) is not a digit"\n' % input_cid_number) + stdout_write('VERBOSE "CallerID number (%s) is not a digit"\n' + % input_cid_number) exit(0) stdout_write('VERBOSE "CallerID number = %s"\n' % input_cid_number) res = False - if options.server: # Yes, this script can be used without "-s openerp_server" ! + # Yes, this script can be used without "-s openerp_server" ! + if options.server: if options.ssl: - stdout_write('VERBOSE "Starting XML-RPC secure request on OpenERP %s:%s"\n' % (options.server, str(options.port))) + stdout_write( + 'VERBOSE "Starting XML-RPC secure request on OpenERP %s:%s"\n' + % (options.server, str(options.port)) + ) protocol = 'https' else: - stdout_write('VERBOSE "Starting clear XML-RPC request on OpenERP %s:%s"\n' % (options.server, str(options.port))) + stdout_write( + 'VERBOSE "Starting clear XML-RPC request on OpenERP %s:%s"\n' + % (options.server, str(options.port)) + ) protocol = 'http' - sock = xmlrpclib.ServerProxy('%s://%s:%s/xmlrpc/object' % (protocol, options.server, str(options.port))) + sock = xmlrpclib.ServerProxy( + '%s://%s:%s/xmlrpc/object' + % (protocol, options.server, str(options.port)) + ) try: - res = sock.execute(options.database, options.user, options.password, 'res.partner.address', 'get_name_from_phone_number', input_cid_number) + res = sock.execute( + options.database, + options.user, + options.password, + 'res.partner.address', + 'get_name_from_phone_number', + input_cid_number + ) stdout_write('VERBOSE "End of XML-RPC request on OpenERP"\n') if not res: stdout_write('VERBOSE "Phone number not found in OpenERP"\n') @@ -200,8 +320,8 @@ def main(options, arguments): stdout_write('VERBOSE "Could not connect to OpenERP"\n') res = False # To simulate a long execution of the XML-RPC request - #import time - #time.sleep(5) + # import time + # time.sleep(5) # Function to limit the size of the CID name to 40 chars if res: @@ -209,14 +329,23 @@ def main(options, arguments): res = res[0:40] elif options.geoloc: # if the number is not found in OpenERP, we try to geolocate - stdout_write('VERBOSE "Trying to geolocate with country %s and lang %s"\n' % (options.country, options.lang)) - res = geolocate_phone_number(input_cid_number, options.country, options.lang) + stdout_write( + 'VERBOSE "Trying to geolocate with country %s and lang %s"\n' + % (options.country, options.lang) + ) + res = geolocate_phone_number( + input_cid_number, + options.country, + options.lang + ) else: - # if the number is not found in OpenERP and geoloc is off, we put 'default_cid_name' as CID Name + # if the number is not found in OpenERP and geoloc is off, + # we put 'default_cid_name' as CID Name res = default_cid_name - # All SIP phones should support UTF-8... but in case you have analog phones over TDM - # or buggy phones, you should use the command line option --ascii + # All SIP phones should support UTF-8... but in case you have analog + # phones over TDM or buggy phones, you should use the command line option + # --ascii if options.ascii: res = convert_to_ascii(res) diff --git a/asterisk_click2dial/wizard/open_calling_partner.py b/asterisk_click2dial/wizard/open_calling_partner.py index b08d97d..f35b77f 100644 --- a/asterisk_click2dial/wizard/open_calling_partner.py +++ b/asterisk_click2dial/wizard/open_calling_partner.py @@ -33,27 +33,62 @@ class wizard_open_calling_partner(osv.osv_memory): _columns = { # I can't set any field to readonly, because otherwize it would call - # default_get (and thus connect to Asterisk) a second time when the user - # clicks on one of the buttons - 'calling_number': fields.char('Calling number', size=30, help="Phone number of calling party that has been obtained from Asterisk."), - 'partner_address_id': fields.many2one('res.partner.address', 'Contact name', help="Partner contact related to the calling number. If there is none and you want to update an existing partner"), - 'partner_id': fields.many2one('res.partner', 'Partner', help="Partner related to the calling number."), - 'to_update_partner_address_id': fields.many2one('res.partner.address', 'Contact to update', help="Partner contact on which the phone or mobile number will be written"), - 'current_phone': fields.related('to_update_partner_address_id', 'phone', type='char', relation='res.partner.address', string='Current phone'), - 'current_mobile': fields.related('to_update_partner_address_id', 'mobile', type='char', relation='res.partner.address', string='Current mobile'), - } - + # default_get (and thus connect to Asterisk) a second time when the + # user clicks on one of the buttons + 'calling_number': fields.char( + 'Calling number', + size=30, + help="Phone number of calling party that has been obtained from " + "Asterisk." + ), + 'partner_address_id': fields.many2one( + 'res.partner.address', + 'Contact name', + help="Partner contact related to the calling number. If there is " + "none and you want to update an existing partner" + ), + 'partner_id': fields.many2one( + 'res.partner', + 'Partner', + help="Partner related to the calling number." + ), + 'to_update_partner_address_id': fields.many2one( + 'res.partner.address', + 'Contact to update', + help="Partner contact on which the phone or mobile number will be " + "written" + ), + 'current_phone': fields.related( + 'to_update_partner_address_id', + 'phone', + type='char', + relation='res.partner.address', + string='Current phone' + ), + 'current_mobile': fields.related( + 'to_update_partner_address_id', + 'mobile', + type='char', + relation='res.partner.address', + string='Current mobile' + ), + } def default_get(self, cr, uid, fields, context=None): - '''Thanks to the default_get method, we are able to query Asterisk and - get the corresponding partner when we launch the wizard''' + """Thanks to the default_get method, we are able to query Asterisk and + get the corresponding partner when we launch the wizard""" res = {} - calling_number = self.pool.get('asterisk.server')._get_calling_number(cr, uid, context=context) - #To test the code without Asterisk server - #calling_number = "0141981242" + calling_number = self.pool.get('asterisk.server')._get_calling_number( + cr, uid, context=context + ) + # To test the code without Asterisk server + # calling_number = "0141981242" if calling_number: res['calling_number'] = calling_number - partner = self.pool.get('res.partner.address').get_partner_from_phone_number(cr, uid, calling_number, context=context) + address_obj = self.pool.get('res.partner.address') + partner = address_obj.get_partner_from_phone_number( + cr, uid, calling_number, context=context + ) if partner: res['partner_address_id'] = partner[0] res['partner_id'] = partner[1] @@ -62,22 +97,38 @@ class wizard_open_calling_partner(osv.osv_memory): res['partner_address_id'] = False res['to_update_partner_address_id'] = False else: - logger.notifyChannel('click2dial', netsvc.LOG_DEBUG, "Could not get the calling number from Asterisk.") - raise osv.except_osv(_('Error :'), _("Could not get the calling number from Asterisk. Are you currently on the phone ? If yes, check your setup and look at the OpenERP debug logs.")) + logger.notifyChannel( + 'click2dial', + netsvc.LOG_DEBUG, + "Could not get the calling number from Asterisk." + ) + raise osv.except_osv( + _('Error :'), + _("Could not get the calling number from Asterisk. " + "Are you currently on the phone ? If yes, check your setup " + "and look at the OpenERP debug logs.") + ) return res - def open_filtered_object(self, cr, uid, ids, oerp_object, context=None): - '''Returns the action that opens the list view of the 'oerp_object' - given as argument filtered on the partner''' + """Returns the action that opens the list view of the 'oerp_object' + given as argument filtered on the partner""" # This module only depends on "base" # and I don't want to add a dependancy on "sale" or "account" # So I just check here that the model exists, to avoid a crash - if not self.pool.get('ir.model').search(cr, uid, [('model', '=', oerp_object._name)], context=context): - raise osv.except_osv(_('Error :'), _("The object '%s' is not found in your OpenERP database, probably because the related module is not installed." % oerp_object._description)) - - partner_id = self.browse(cr, uid, ids[0], context=context).partner_id.id + if not self.pool.get('ir.model').search( + cr, uid, [('model', '=', oerp_object._name)], context=context + ): + raise osv.except_osv( + _('Error :'), + _("The object '%s' is not found in your OpenERP database, " + "probably because the related module is not installed." + % oerp_object._description) + ) + + partner_id = self.browse( + cr, uid, ids[0], context=context).partner_id.id if partner_id: action = { 'name': oerp_object._description, @@ -85,34 +136,41 @@ class wizard_open_calling_partner(osv.osv_memory): 'view_mode': 'tree,form', 'res_model': oerp_object._name, 'type': 'ir.actions.act_window', - 'nodestroy': False, # close the pop-up wizard after action + 'nodestroy': False, # close the pop-up wizard after action 'target': 'current', 'domain': [('partner_id', '=', partner_id)], - } + } return action else: return False - def open_sale_orders(self, cr, uid, ids, context=None): - '''Function called by the related button of the wizard''' - return self.open_filtered_object(cr, uid, ids, self.pool.get('sale.order'), context=context) - + """Function called by the related button of the wizard""" + return self.open_filtered_object( + cr, uid, ids, self.pool.get('sale.order'), context=context + ) def open_invoices(self, cr, uid, ids, context=None): - '''Function called by the related button of the wizard''' - return self.open_filtered_object(cr, uid, ids, self.pool.get('account.invoice'), context=context) - + """Function called by the related button of the wizard""" + return self.open_filtered_object( + cr, uid, ids, self.pool.get('account.invoice'), context=context + ) - def simple_open(self, cr, uid, ids, object_name='res.partner', context=None): + def simple_open(self, cr, uid, ids, object_name='res.partner', + context=None): if object_name == 'res.partner': - record_id = self.browse(cr, uid, ids[0], context=context).partner_id.id + record_id = self.browse( + cr, uid, ids[0], context=context).partner_id.id label = 'Partner' elif object_name == 'res.partner.address': - record_id = self.browse(cr, uid, ids[0], context=context).partner_address_id.id + record_id = self.browse( + cr, uid, ids[0], context=context).partner_address_id.id label = 'Contact' else: - raise osv.except_osv(_('Error :'), "This object '%s' is not supported" % object_name) + raise osv.except_osv( + _('Error :'), + "This object '%s' is not supported" % object_name + ) if record_id: return { 'name': label, @@ -120,30 +178,39 @@ class wizard_open_calling_partner(osv.osv_memory): 'view_mode': 'form,tree', 'res_model': object_name, 'type': 'ir.actions.act_window', - 'nodestroy': False, # close the pop-up wizard after action + 'nodestroy': False, # close the pop-up wizard after action 'target': 'current', 'res_id': record_id, - } + } else: return False - def open_partner(self, cr, uid, ids, context=None): - '''Function called by the related button of the wizard''' - return self.simple_open(cr, uid, ids, object_name='res.partner', context=context) - + """Function called by the related button of the wizard""" + return self.simple_open( + cr, uid, ids, object_name='res.partner', context=context + ) def open_partner_address(self, cr, uid, ids, context=None): - '''Function called by the related button of the wizard''' - return self.simple_open(cr, uid, ids, object_name='res.partner.address', context=context) - - - def create_partner_address(self, cr, uid, ids, phone_type='phone', context=None): - '''Function called by the related button of the wizard''' - calling_number = self.read(cr, uid, ids[0], ['calling_number'], context=context)['calling_number'] - ast_server = self.pool.get('asterisk.server')._get_asterisk_server_from_user(cr, uid, context=context) + """Function called by the related button of the wizard""" + return self.simple_open( + cr, uid, ids, object_name='res.partner.address', context=context + ) + + def create_partner_address(self, cr, uid, ids, phone_type='phone', + context=None): + """Function called by the related button of the wizard""" + calling_number = self.read( + cr, uid, ids[0], ['calling_number'], context=context + )['calling_number'] + ast_srv_obj = self.pool.get('asterisk.server') + ast_server = ast_srv_obj._get_asterisk_server_from_user( + cr, uid, context=context + ) # Convert the number to the international format - number_to_write = self.pool.get('asterisk.server')._convert_number_to_international_format(cr, uid, calling_number, ast_server, context=context) + number_to_write = ast_srv_obj._convert_number_to_international_format( + cr, uid, calling_number, ast_server, context=context + ) context['default_' + phone_type] = number_to_write action = { @@ -158,22 +225,36 @@ class wizard_open_calling_partner(osv.osv_memory): } return action - def create_partner_address_phone(self, cr, uid, ids, context=None): - return self.create_partner_address(cr, uid, ids, phone_type='phone', context=context) - + return self.create_partner_address( + cr, uid, ids, phone_type='phone', context=context + ) def create_partner_address_mobile(self, cr, uid, ids, context=None): - return self.create_partner_address(cr, uid, ids, phone_type='mobile', context=context) - + return self.create_partner_address( + cr, uid, ids, phone_type='mobile', context=context + ) - def update_partner_address(self, cr, uid, ids, phone_type='mobile', context=None): + def update_partner_address(self, cr, uid, ids, phone_type='mobile', + context=None): cur_wizard = self.browse(cr, uid, ids[0], context=context) if not cur_wizard.to_update_partner_address_id: - raise osv.except_osv(_('Error :'), _("Select the contact to update.")) - ast_server = self.pool.get('asterisk.server')._get_asterisk_server_from_user(cr, uid, context=context) - number_to_write = self.pool.get('asterisk.server')._convert_number_to_international_format(cr, uid, cur_wizard.calling_number, ast_server, context=context) - self.pool.get('res.partner.address').write(cr, uid, cur_wizard.to_update_partner_address_id.id, {phone_type: number_to_write}, context=context) + raise osv.except_osv( + _('Error :'), + _("Select the contact to update.") + ) + ast_srv_obj = self.pool.get('asterisk.server') + ast_server = ast_srv_obj._get_asterisk_server_from_user( + cr, uid, context=context + ) + number_to_write = ast_srv_obj._convert_number_to_international_format( + cr, uid, cur_wizard.calling_number, ast_server, context=context + ) + self.pool.get('res.partner.address').write( + cr, uid, cur_wizard.to_update_partner_address_id.id, + {phone_type: number_to_write}, + context=context + ) action = { 'name': 'Contact: ' + cur_wizard.to_update_partner_address_id.name, 'view_type': 'form', @@ -183,27 +264,38 @@ class wizard_open_calling_partner(osv.osv_memory): 'nodestroy': False, 'target': 'current', 'res_id': cur_wizard.to_update_partner_address_id.id - } + } return action - def update_partner_address_phone(self, cr, uid, ids, context=None): - return self.update_partner_address(cr, uid, ids, phone_type='phone', context=context) - + return self.update_partner_address( + cr, uid, ids, phone_type='phone', context=context + ) def update_partner_address_mobile(self, cr, uid, ids, context=None): - return self.update_partner_address(cr, uid, ids, phone_type='mobile', context=context) - + return self.update_partner_address( + cr, uid, ids, phone_type='mobile', context=context + ) - def onchange_to_update_partner_address(self, cr, uid, ids, to_update_partner_address_id, context=None): + def onchange_to_update_partner_address(self, cr, uid, ids, + to_update_partner_address_id, + context=None): res = {} res['value'] = {} if to_update_partner_address_id: - to_update_partner_address = self.pool.get('res.partner.address').browse(cr, uid, to_update_partner_address_id, context=context) - res['value'].update({'current_phone': to_update_partner_address.phone, - 'current_mobile': to_update_partner_address.mobile}) + address_obj = self.pool.get('res.partner.address') + to_update_partner_address = address_obj.browse( + cr, uid, to_update_partner_address_id, context=context + ) + res['value'].update({ + 'current_phone': to_update_partner_address.phone, + 'current_mobile': to_update_partner_address.mobile + }) else: - res['value'].update({'current_phone': False, 'current_mobile': False}) + res['value'].update({ + 'current_phone': False, + 'current_mobile': False, + }) return res wizard_open_calling_partner() diff --git a/asterisk_click2dial/wizard/reformat_all_phonenumbers.py b/asterisk_click2dial/wizard/reformat_all_phonenumbers.py index c4f8be9..09b9ed9 100644 --- a/asterisk_click2dial/wizard/reformat_all_phonenumbers.py +++ b/asterisk_click2dial/wizard/reformat_all_phonenumbers.py @@ -21,7 +21,6 @@ from osv import osv, fields import netsvc -from tools.translate import _ logger = netsvc.Logger() @@ -29,39 +28,72 @@ logger = netsvc.Logger() class reformat_all_phonenumbers(osv.osv_memory): _name = "reformat.all.phonenumbers" _description = "Reformat all phone numbers" - _columns = { - 'phonenumbers_not_reformatted': fields.text("Phone numbers that couldn't be reformatted"), - } - + 'phonenumbers_not_reformatted': fields.text( + "Phone numbers that couldn't be reformatted" + ), + } def run_reformat_all_phonenumbers(self, cr, uid, ids, context=None): print "RUN ids=", ids addr_obj = self.pool.get('res.partner.address') phonefields = ['phone', 'fax', 'mobile'] - logger.notifyChannel('click2dial', netsvc.LOG_INFO, 'Starting to reformat all the phone numbers') - all_addr_ids = addr_obj.search(cr, uid, ['|', ('active', '=', True), ('active', '=', False)], context=context) + logger.notifyChannel( + 'click2dial', + netsvc.LOG_INFO, + 'Starting to reformat all the phone numbers' + ) + all_addr_ids = addr_obj.search( + cr, uid, [ + '|', + ('active', '=', True), + ('active', '=', False) + ], context=context + ) phonenumbers_not_reformatted = '' - for addr in addr_obj.read(cr, uid, all_addr_ids, ['name'] + phonefields, context=context): + for addr in addr_obj.read( + cr, uid, all_addr_ids, ['name'] + phonefields, context=context + ): init_addr = addr.copy() # addr is _updated_ by the fonction _reformat_phonenumbers() try: addr_obj._reformat_phonenumbers(cr, uid, addr, context=context) except Exception, e: - #raise osv.except_osv(_('Error :'), _("Problem on partner contact '%s'. Error message: %s" % (init_addr.get('name'), e[1]))) - phonenumbers_not_reformatted += "Problem on partner contact '%s'. Error message: %s" % (init_addr.get('name'), e[1]) + "\n" - logger.notifyChannel('click2dial', netsvc.LOG_WARNING, "Problem on partner contact '%s'. Error message: %s" % (init_addr.get('name'), e[1])) + phonenumbers_not_reformatted += ( + "Problem on partner contact '%s'. " + "Error message: %s" % (init_addr.get('name'), e[1]) + "\n" + ) + logger.notifyChannel( + 'click2dial', + netsvc.LOG_WARNING, + "Problem on partner contact '%s'. Error message: %s" + % (init_addr.get('name'), e[1]) + ) continue # Test if the phone numbers have been changed - if any([init_addr.get(field) != addr.get(field) for field in phonefields]): + if any([init_addr.get(field) != addr.get(field) + for field in phonefields]): addr.pop('id') addr.pop('name') - logger.notifyChannel('click2dial', netsvc.LOG_INFO, 'Reformating phone number: FROM %s TO %s' % (unicode(init_addr), unicode(addr))) + logger.notifyChannel( + 'click2dial', + netsvc.LOG_INFO, + 'Reformating phone number: FROM %s TO %s' + % (unicode(init_addr), unicode(addr)) + ) addr_obj.write(cr, uid, init_addr['id'], addr, context=context) if not phonenumbers_not_reformatted: - phonenumbers_not_reformatted = 'All phone numbers have been reformatted successfully.' - self.write(cr, uid, ids, {'phonenumbers_not_reformatted': phonenumbers_not_reformatted}, context=context) - logger.notifyChannel('click2dial', netsvc.LOG_INFO, 'End of the phone number reformatting wizard') + phonenumbers_not_reformatted = ( + 'All phone numbers have been reformatted successfully.' + ) + self.write(cr, uid, ids, { + 'phonenumbers_not_reformatted': phonenumbers_not_reformatted + }, context=context) + logger.notifyChannel( + 'click2dial', + netsvc.LOG_INFO, + 'End of the phone number reformatting wizard' + ) return True reformat_all_phonenumbers() diff --git a/asterisk_click2dial_crm/__init__.py b/asterisk_click2dial_crm/__init__.py index be2809c..3b0499d 100644 --- a/asterisk_click2dial_crm/__init__.py +++ b/asterisk_click2dial_crm/__init__.py @@ -2,14 +2,15 @@ ############################################################################## # # Asterisk click2dial CRM module for OpenERP -# Copyright (c) 2011 Zikzakmedia S.L. (http://zikzakmedia.com) All Rights Reserved. +# Copyright (c) 2011 Zikzakmedia S.L. (http://zikzakmedia.com) +# All Rights Reserved. # Copyright (c) 2012 Akretion (http://www.akretion.com) # @author: Jesús Martín # @author: Alexis de Lattre # # This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU Affero General Public License as published by -# the Free Software Foundation, either version 3 of the License, or +# it under the terms of the GNU Affero 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, diff --git a/asterisk_click2dial_crm/__terp__.py b/asterisk_click2dial_crm/__terp__.py index 7a86d5f..6f8b601 100644 --- a/asterisk_click2dial_crm/__terp__.py +++ b/asterisk_click2dial_crm/__terp__.py @@ -2,14 +2,15 @@ ############################################################################## # # Asterisk click2dial CRM module for OpenERP -# Copyright (c) 2011 Zikzakmedia S.L. (http://zikzakmedia.com) All Rights Reserved. +# Copyright (c) 2011 Zikzakmedia S.L. (http://zikzakmedia.com) +# All Rights Reserved. # Copyright (c) 2012 Akretion (http://www.akretion.com) # @author: Jesús Martín # @author: Alexis de Lattre # # This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU Affero General Public License as published by -# the Free Software Foundation, either version 3 of the License, or +# it under the terms of the GNU Affero 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, @@ -27,27 +28,30 @@ "version": "0.1", "author": "Zikzakmedia SL, Akretion", "website": "http://www.zikzakmedia.com", - "license" : "AGPL-3", + "license": "AGPL-3", "category": "Customer Relationship Management", "description": """ - This module adds CRM-specific features to the asterisk_click2dial module. +This module adds CRM-specific features to the asterisk_click2dial module. - It adds 2 features : +It adds 2 features : - First, when you do a click2dial, OpenERP will propose you to create an - outbound phone call in the CRM ; if you answer 'Yes', it will create the phone - call in the CRM and open it in a new tab. If some users don't want to be asked - to create a phone call in the CRM each time they do a click2dial, you - should disable the corresponding option in the 'Telephony' tab of the 'User' - form. +First, when you do a click2dial, OpenERP will propose you to create an +outbound phone call in the CRM ; if you answer 'Yes', it will create the phone +call in the CRM and open it in a new tab. If some users don't want to be asked +to create a phone call in the CRM each time they do a click2dial, you +should disable the corresponding option in the 'Telephony' tab of the 'User' +form. - Second, when you receive a phone call and run the wizard "Open calling partner", - if the partner is found in OpenERP, you will see a button that proposes to create - an inbound phone call in the CRM. +Second, when you receive a phone call and run the wizard +"Open calling partner", if the partner is found in OpenERP, you will see a +button that proposes to create an inbound phone call in the CRM. - This module has been initially developped by Zikzakmedia and has been enhanced by Akretion. +This module has been initially developped by Zikzakmedia and has been enhanced +by Akretion. - A detailed documentation for the OpenERP-Asterisk connector is available on the Akretion Web site : http://www.akretion.com/en/products-and-services/openerp-asterisk-voip-connector +A detailed documentation for the OpenERP-Asterisk connector is available on the +Akretion Web site : +http://www.akretion.com/products-and-services/openerp-asterisk-voip-connector """, "depends": [ 'asterisk_click2dial', diff --git a/asterisk_click2dial_crm/asterisk_click2dial_crm.py b/asterisk_click2dial_crm/asterisk_click2dial_crm.py index 02b785b..f256d2c 100644 --- a/asterisk_click2dial_crm/asterisk_click2dial_crm.py +++ b/asterisk_click2dial_crm/asterisk_click2dial_crm.py @@ -2,14 +2,15 @@ ############################################################################## # # Asterisk click2dial CRM module for OpenERP -# Copyright (c) 2011 Zikzakmedia S.L. (http://zikzakmedia.com) All Rights Reserved. +# Copyright (c) 2011 Zikzakmedia S.L. (http://zikzakmedia.com) +# All Rights Reserved. # Copyright (c) 2012 Akretion (http://www.akretion.com) # @author: Jesús Martín # @author: Alexis de Lattre # # This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU Affero General Public License as published by -# the Free Software Foundation, either version 3 of the License, or +# it under the terms of the GNU Affero 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, @@ -23,8 +24,7 @@ ############################################################################## from osv import osv, fields -# Lib to translate error messages -from tools.translate import _ + class res_partner_address(osv.osv): _inherit = "res.partner.address" @@ -37,7 +37,9 @@ class res_partner_address(osv.osv): ''' if context is None: context = {} - super(res_partner_address, self).dial(cr, uid, ids, phone_field=phone_field, context=context) + super(res_partner_address, self).dial( + cr, uid, ids, phone_field=phone_field, context=context + ) user = self.pool.get('res.users').browse(cr, uid, uid, context=context) context['partner_address_id'] = ids[0] action_start_wizard = { @@ -66,12 +68,13 @@ class res_users(osv.osv): # in his preferences, cf server/openerp/addons/base/res/res_users.py # in "def write" of "class users" # This exists in since OpenERP 6.0 (it is not in OpenERP 5.0) - 'context_propose_creation_crm_call': fields.boolean('Propose to create a call in CRM after a click2dial'), - } + 'context_propose_creation_crm_call': fields.boolean( + 'Propose to create a call in CRM after a click2dial' + ), + } _defaults = { 'context_propose_creation_crm_call': lambda *a: True, - } + } res_users() - diff --git a/asterisk_click2dial_crm/wizard/__init__.py b/asterisk_click2dial_crm/wizard/__init__.py index 9200a68..9f6310c 100644 --- a/asterisk_click2dial_crm/wizard/__init__.py +++ b/asterisk_click2dial_crm/wizard/__init__.py @@ -6,8 +6,8 @@ # @author: Alexis de Lattre # # This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU Affero General Public License as published by -# the Free Software Foundation, either version 3 of the License, or +# it under the terms of the GNU Affero 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, diff --git a/asterisk_click2dial_crm/wizard/create_crm_phonecall.py b/asterisk_click2dial_crm/wizard/create_crm_phonecall.py index f919c5c..85852ea 100644 --- a/asterisk_click2dial_crm/wizard/create_crm_phonecall.py +++ b/asterisk_click2dial_crm/wizard/create_crm_phonecall.py @@ -2,14 +2,15 @@ ############################################################################## # # Asterisk click2dial CRM module for OpenERP -# Copyright (c) 2011 Zikzakmedia S.L. (http://zikzakmedia.com) All Rights Reserved. +# Copyright (c) 2011 Zikzakmedia S.L. (http://zikzakmedia.com) +# All Rights Reserved. # Copyright (c) 2012 Akretion (http://www.akretion.com) # @author: Jesús Martín # @author: Alexis de Lattre # # This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU Affero General Public License as published by -# the Free Software Foundation, either version 3 of the License, or +# it under the terms of the GNU Affero 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, @@ -22,33 +23,45 @@ # ############################################################################## -from osv import osv, fields -# Lib to translate error messages -from tools.translate import _ +from osv import osv class wizard_create_crm_phonecall(osv.osv_memory): _name = "wizard.create.crm.phonecall" def button_create_outgoing_phonecall(self, cr, uid, ids, context=None): - partner_address = self.pool.get('res.partner.address').browse(cr, uid, context.get('partner_address_id'), context=context) - return self._create_open_crm_phonecall(cr, uid, partner_address, crm_categ='Outbound', context=context) + partner_address = self.pool.get('res.partner.address').browse( + cr, uid, context.get('partner_address_id'), context=context + ) + return self._create_open_crm_phonecall( + cr, uid, partner_address, crm_categ='Outbound', context=context + ) - def _create_open_crm_phonecall(self, cr, uid, partner_address, crm_categ, context=None): + def _create_open_crm_phonecall(self, cr, uid, partner_address, crm_categ, + context=None): if context is None: context = {} - crm_phonecall_obj = self.pool.get('crm.phonecall') - categ_ids = self.pool.get('crm.case.categ').search(cr, uid, [('name','=',crm_categ)], context={'lang': 'en_US'}) - case_section_ids = self.pool.get('crm.case.section').search(cr, uid, [('member_ids', 'in', uid)], context=context) + categ_ids = self.pool.get('crm.case.categ').search( + cr, uid, [('name', '=', crm_categ)], context={'lang': 'en_US'} + ) + case_section_ids = self.pool.get('crm.case.section').search( + cr, uid, [('member_ids', 'in', uid)], context=context + ) context.update({ - 'default_partner_id': partner_address.partner_id and partner_address.partner_id.id or False, + 'default_partner_id': ( + partner_address.partner_id + and partner_address.partner_id.id + or False + ), 'default_partner_address_id': partner_address.id, 'default_partner_contact': partner_address.name, 'default_partner_phone': partner_address.phone, 'default_partner_mobile': partner_address.mobile, 'default_categ_id': categ_ids and categ_ids[0] or False, - 'default_section_id': case_section_ids and case_section_ids[0] or False, + 'default_section_id': ( + case_section_ids and case_section_ids[0] or False + ), }) return { @@ -58,7 +71,7 @@ class wizard_create_crm_phonecall(osv.osv_memory): 'view_type': 'form', 'view_mode': 'form,tree', 'type': 'ir.actions.act_window', - 'nodestroy': False, # close the pop-up wizard after action + 'nodestroy': False, # close the pop-up wizard after action 'target': 'current', 'context': context, } @@ -70,9 +83,14 @@ class wizard_open_calling_partner(osv.osv_memory): _inherit = "wizard.open.calling.partner" def create_incoming_phonecall(self, cr, uid, ids, crm_categ, context=None): - '''Started by button on 'open calling partner wizard''' - partner_address = self.browse(cr, uid, ids[0], context=context).partner_address_id - action = self.pool.get('wizard.create.crm.phonecall')._create_open_crm_phonecall(cr, uid, partner_address, crm_categ='Inbound', context=context) + """Started by button on 'open calling partner wizard""" + partner_address = ( + self.browse(cr, uid, ids[0], context=context).partner_address_id + ) + wizard_obj = self.pool.get('wizard.create.crm.phonecall') + action = wizard_obj._create_open_crm_phonecall( + cr, uid, partner_address, crm_categ='Inbound', context=context + ) return action wizard_open_calling_partner()