Skip to content

A
aeroolib
Commit d4bcf71d by Long Phan
Options

up

parents
Showing with 4007 additions and 0 deletions
AUTHORS 0 → 100644
Aeroo Library developed by:
Alistek Ltd. <info@alistek.com>
relatorio is the work of:
Nicolas Évrard <nicoe@openhex.org>
Gaëtan de Menten <gdementen@openhex.org>
We included ideas and patches from:
Cédric Krier <cedric.krier@b2ck.com>
Udo Spallek <udono@virtual-things.biz>
CHANGES 0 → 100644
1.0.0 - 20101215
Initial version
LICENSE 0 → 100644
GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The GNU General Public License is a free, copyleft license for
software and other kinds of works.
The licenses for most software and other practical works are designed
to take away your freedom to share and change the works. By contrast,
the GNU General Public License is intended to guarantee your freedom to
share and change all versions of a program--to make sure it remains free
software for all its users. We, the Free Software Foundation, use the
GNU General Public License for most of our software; it applies also to
any other work released this way by its authors. You can apply it to
your programs, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
them if you wish), that you receive source code or can get it if you
want it, that you can change the software or use pieces of it in new
free programs, and that you know you can do these things.
To protect your rights, we need to prevent others from denying you
these rights or asking you to surrender the rights. Therefore, you have
certain responsibilities if you distribute copies of the software, or if
you modify it: responsibilities to respect the freedom of others.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must pass on to the recipients the same
freedoms that you received. You must make sure that they, too, receive
or can get the source code. And you must show them these terms so they
know their rights.
Developers that use the GNU GPL protect your rights with two steps:
(1) assert copyright on the software, and (2) offer you this License
giving you legal permission to copy, distribute and/or modify it.
For the developers' and authors' protection, the GPL clearly explains
that there is no warranty for this free software. For both users' and
authors' sake, the GPL requires that modified versions be marked as
changed, so that their problems will not be attributed erroneously to
authors of previous versions.
Some devices are designed to deny users access to install or run
modified versions of the software inside them, although the manufacturer
can do so. This is fundamentally incompatible with the aim of
protecting users' freedom to change the software. The systematic
pattern of such abuse occurs in the area of products for individuals to
use, which is precisely where it is most unacceptable. Therefore, we
have designed this version of the GPL to prohibit the practice for those
products. If such problems arise substantially in other domains, we
stand ready to extend this provision to those domains in future versions
of the GPL, as needed to protect the freedom of users.
Finally, every program is threatened constantly by software patents.
States should not allow patents to restrict development and use of
software on general-purpose computers, but in those that do, we wish to
avoid the special danger that patents applied to a free program could
make it effectively proprietary. To prevent this, the GPL assures that
patents cannot be used to render the program non-free.
The precise terms and conditions for copying, distribution and
modification follow.
TERMS AND CONDITIONS
0. Definitions.
"This License" refers to version 3 of the GNU General Public License.
"Copyright" also means copyright-like laws that apply to other kinds of
works, such as semiconductor masks.
"The Program" refers to any copyrightable work licensed under this
License. Each licensee is addressed as "you". "Licensees" and
"recipients" may be individuals or organizations.
To "modify" a work means to copy from or adapt all or part of the work
in a fashion requiring copyright permission, other than the making of an
exact copy. The resulting work is called a "modified version" of the
earlier work or a work "based on" the earlier work.
A "covered work" means either the unmodified Program or a work based
on the Program.
To "propagate" a work means to do anything with it that, without
permission, would make you directly or secondarily liable for
infringement under applicable copyright law, except executing it on a
computer or modifying a private copy. Propagation includes copying,
distribution (with or without modification), making available to the
public, and in some countries other activities as well.
To "convey" a work means any kind of propagation that enables other
parties to make or receive copies. Mere interaction with a user through
a computer network, with no transfer of a copy, is not conveying.
An interactive user interface displays "Appropriate Legal Notices"
to the extent that it includes a convenient and prominently visible
feature that (1) displays an appropriate copyright notice, and (2)
tells the user that there is no warranty for the work (except to the
extent that warranties are provided), that licensees may convey the
work under this License, and how to view a copy of this License. If
the interface presents a list of user commands or options, such as a
menu, a prominent item in the list meets this criterion.
1. Source Code.
The "source code" for a work means the preferred form of the work
for making modifications to it. "Object code" means any non-source
form of a work.
A "Standard Interface" means an interface that either is an official
standard defined by a recognized standards body, or, in the case of
interfaces specified for a particular programming language, one that
is widely used among developers working in that language.
The "System Libraries" of an executable work include anything, other
than the work as a whole, that (a) is included in the normal form of
packaging a Major Component, but which is not part of that Major
Component, and (b) serves only to enable use of the work with that
Major Component, or to implement a Standard Interface for which an
implementation is available to the public in source code form. A
"Major Component", in this context, means a major essential component
(kernel, window system, and so on) of the specific operating system
(if any) on which the executable work runs, or a compiler used to
produce the work, or an object code interpreter used to run it.
The "Corresponding Source" for a work in object code form means all
the source code needed to generate, install, and (for an executable
work) run the object code and to modify the work, including scripts to
control those activities. However, it does not include the work's
System Libraries, or general-purpose tools or generally available free
programs which are used unmodified in performing those activities but
which are not part of the work. For example, Corresponding Source
includes interface definition files associated with source files for
the work, and the source code for shared libraries and dynamically
linked subprograms that the work is specifically designed to require,
such as by intimate data communication or control flow between those
subprograms and other parts of the work.
The Corresponding Source need not include anything that users
can regenerate automatically from other parts of the Corresponding
Source.
The Corresponding Source for a work in source code form is that
same work.
2. Basic Permissions.
All rights granted under this License are granted for the term of
copyright on the Program, and are irrevocable provided the stated
conditions are met. This License explicitly affirms your unlimited
permission to run the unmodified Program. The output from running a
covered work is covered by this License only if the output, given its
content, constitutes a covered work. This License acknowledges your
rights of fair use or other equivalent, as provided by copyright law.
You may make, run and propagate covered works that you do not
convey, without conditions so long as your license otherwise remains
in force. You may convey covered works to others for the sole purpose
of having them make modifications exclusively for you, or provide you
with facilities for running those works, provided that you comply with
the terms of this License in conveying all material for which you do
not control copyright. Those thus making or running the covered works
for you must do so exclusively on your behalf, under your direction
and control, on terms that prohibit them from making any copies of
your copyrighted material outside their relationship with you.
Conveying under any other circumstances is permitted solely under
the conditions stated below. Sublicensing is not allowed; section 10
makes it unnecessary.
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
No covered work shall be deemed part of an effective technological
measure under any applicable law fulfilling obligations under article
11 of the WIPO copyright treaty adopted on 20 December 1996, or
similar laws prohibiting or restricting circumvention of such
measures.
When you convey a covered work, you waive any legal power to forbid
circumvention of technological measures to the extent such circumvention
is effected by exercising rights under this License with respect to
the covered work, and you disclaim any intention to limit operation or
modification of the work as a means of enforcing, against the work's
users, your or third parties' legal rights to forbid circumvention of
technological measures.
4. Conveying Verbatim Copies.
You may convey verbatim copies of the Program's source code as you
receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice;
keep intact all notices stating that this License and any
non-permissive terms added in accord with section 7 apply to the code;
keep intact all notices of the absence of any warranty; and give all
recipients a copy of this License along with the Program.
You may charge any price or no price for each copy that you convey,
and you may offer support or warranty protection for a fee.
5. Conveying Modified Source Versions.
You may convey a work based on the Program, or the modifications to
produce it from the Program, in the form of source code under the
terms of section 4, provided that you also meet all of these conditions:
a) The work must carry prominent notices stating that you modified
it, and giving a relevant date.
b) The work must carry prominent notices stating that it is
released under this License and any conditions added under section
7. This requirement modifies the requirement in section 4 to
"keep intact all notices".
c) You must license the entire work, as a whole, under this
License to anyone who comes into possession of a copy. This
License will therefore apply, along with any applicable section 7
additional terms, to the whole of the work, and all its parts,
regardless of how they are packaged. This License gives no
permission to license the work in any other way, but it does not
invalidate such permission if you have separately received it.
d) If the work has interactive user interfaces, each must display
Appropriate Legal Notices; however, if the Program has interactive
interfaces that do not display Appropriate Legal Notices, your
work need not make them do so.
A compilation of a covered work with other separate and independent
works, which are not by their nature extensions of the covered work,
and which are not combined with it such as to form a larger program,
in or on a volume of a storage or distribution medium, is called an
"aggregate" if the compilation and its resulting copyright are not
used to limit the access or legal rights of the compilation's users
beyond what the individual works permit. Inclusion of a covered work
in an aggregate does not cause this License to apply to the other
parts of the aggregate.
6. Conveying Non-Source Forms.
You may convey a covered work in object code form under the terms
of sections 4 and 5, provided that you also convey the
machine-readable Corresponding Source under the terms of this License,
in one of these ways:
a) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by the
Corresponding Source fixed on a durable physical medium
customarily used for software interchange.
b) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by a
written offer, valid for at least three years and valid for as
long as you offer spare parts or customer support for that product
model, to give anyone who possesses the object code either (1) a
copy of the Corresponding Source for all the software in the
product that is covered by this License, on a durable physical
medium customarily used for software interchange, for a price no
more than your reasonable cost of physically performing this
conveying of source, or (2) access to copy the
Corresponding Source from a network server at no charge.
c) Convey individual copies of the object code with a copy of the
written offer to provide the Corresponding Source. This
alternative is allowed only occasionally and noncommercially, and
only if you received the object code with such an offer, in accord
with subsection 6b.
d) Convey the object code by offering access from a designated
place (gratis or for a charge), and offer equivalent access to the
Corresponding Source in the same way through the same place at no
further charge. You need not require recipients to copy the
Corresponding Source along with the object code. If the place to
copy the object code is a network server, the Corresponding Source
may be on a different server (operated by you or a third party)
that supports equivalent copying facilities, provided you maintain
clear directions next to the object code saying where to find the
Corresponding Source. Regardless of what server hosts the
Corresponding Source, you remain obligated to ensure that it is
available for as long as needed to satisfy these requirements.
e) Convey the object code using peer-to-peer transmission, provided
you inform other peers where the object code and Corresponding
Source of the work are being offered to the general public at no
charge under subsection 6d.
A separable portion of the object code, whose source code is excluded
from the Corresponding Source as a System Library, need not be
included in conveying the object code work.
A "User Product" is either (1) a "consumer product", which means any
tangible personal property which is normally used for personal, family,
or household purposes, or (2) anything designed or sold for incorporation
into a dwelling. In determining whether a product is a consumer product,
doubtful cases shall be resolved in favor of coverage. For a particular
product received by a particular user, "normally used" refers to a
typical or common use of that class of product, regardless of the status
of the particular user or of the way in which the particular user
actually uses, or expects or is expected to use, the product. A product
is a consumer product regardless of whether the product has substantial
commercial, industrial or non-consumer uses, unless such uses represent
the only significant mode of use of the product.
"Installation Information" for a User Product means any methods,
procedures, authorization keys, or other information required to install
and execute modified versions of a covered work in that User Product from
a modified version of its Corresponding Source. The information must
suffice to ensure that the continued functioning of the modified object
code is in no case prevented or interfered with solely because
modification has been made.
If you convey an object code work under this section in, or with, or
specifically for use in, a User Product, and the conveying occurs as
part of a transaction in which the right of possession and use of the
User Product is transferred to the recipient in perpetuity or for a
fixed term (regardless of how the transaction is characterized), the
Corresponding Source conveyed under this section must be accompanied
by the Installation Information. But this requirement does not apply
if neither you nor any third party retains the ability to install
modified object code on the User Product (for example, the work has
been installed in ROM).
The requirement to provide Installation Information does not include a
requirement to continue to provide support service, warranty, or updates
for a work that has been modified or installed by the recipient, or for
the User Product in which it has been modified or installed. Access to a
network may be denied when the modification itself materially and
adversely affects the operation of the network or violates the rules and
protocols for communication across the network.
Corresponding Source conveyed, and Installation Information provided,
in accord with this section must be in a format that is publicly
documented (and with an implementation available to the public in
source code form), and must require no special password or key for
unpacking, reading or copying.
7. Additional Terms.
"Additional permissions" are terms that supplement the terms of this
License by making exceptions from one or more of its conditions.
Additional permissions that are applicable to the entire Program shall
be treated as though they were included in this License, to the extent
that they are valid under applicable law. If additional permissions
apply only to part of the Program, that part may be used separately
under those permissions, but the entire Program remains governed by
this License without regard to the additional permissions.
When you convey a copy of a covered work, you may at your option
remove any additional permissions from that copy, or from any part of
it. (Additional permissions may be written to require their own
removal in certain cases when you modify the work.) You may place
additional permissions on material, added by you to a covered work,
for which you have or can give appropriate copyright permission.
Notwithstanding any other provision of this License, for material you
add to a covered work, you may (if authorized by the copyright holders of
that material) supplement the terms of this License with terms:
a) Disclaiming warranty or limiting liability differently from the
terms of sections 15 and 16 of this License; or
b) Requiring preservation of specified reasonable legal notices or
author attributions in that material or in the Appropriate Legal
Notices displayed by works containing it; or
c) Prohibiting misrepresentation of the origin of that material, or
requiring that modified versions of such material be marked in
reasonable ways as different from the original version; or
d) Limiting the use for publicity purposes of names of licensors or
authors of the material; or
e) Declining to grant rights under trademark law for use of some
trade names, trademarks, or service marks; or
f) Requiring indemnification of licensors and authors of that
material by anyone who conveys the material (or modified versions of
it) with contractual assumptions of liability to the recipient, for
any liability that these contractual assumptions directly impose on
those licensors and authors.
All other non-permissive additional terms are considered "further
restrictions" within the meaning of section 10. If the Program as you
received it, or any part of it, contains a notice stating that it is
governed by this License along with a term that is a further
restriction, you may remove that term. If a license document contains
a further restriction but permits relicensing or conveying under this
License, you may add to a covered work material governed by the terms
of that license document, provided that the further restriction does
not survive such relicensing or conveying.
If you add terms to a covered work in accord with this section, you
must place, in the relevant source files, a statement of the
additional terms that apply to those files, or a notice indicating
where to find the applicable terms.
Additional terms, permissive or non-permissive, may be stated in the
form of a separately written license, or stated as exceptions;
the above requirements apply either way.
8. Termination.
You may not propagate or modify a covered work except as expressly
provided under this License. Any attempt otherwise to propagate or
modify it is void, and will automatically terminate your rights under
this License (including any patent licenses granted under the third
paragraph of section 11).
However, if you cease all violation of this License, then your
license from a particular copyright holder is reinstated (a)
provisionally, unless and until the copyright holder explicitly and
finally terminates your license, and (b) permanently, if the copyright
holder fails to notify you of the violation by some reasonable means
prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.
Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License. If your rights have been terminated and not permanently
reinstated, you do not qualify to receive new licenses for the same
material under section 10.
9. Acceptance Not Required for Having Copies.
You are not required to accept this License in order to receive or
run a copy of the Program. Ancillary propagation of a covered work
occurring solely as a consequence of using peer-to-peer transmission
to receive a copy likewise does not require acceptance. However,
nothing other than this License grants you permission to propagate or
modify any covered work. These actions infringe copyright if you do
not accept this License. Therefore, by modifying or propagating a
covered work, you indicate your acceptance of this License to do so.
10. Automatic Licensing of Downstream Recipients.
Each time you convey a covered work, the recipient automatically
receives a license from the original licensors, to run, modify and
propagate that work, subject to this License. You are not responsible
for enforcing compliance by third parties with this License.
An "entity transaction" is a transaction transferring control of an
organization, or substantially all assets of one, or subdividing an
organization, or merging organizations. If propagation of a covered
work results from an entity transaction, each party to that
transaction who receives a copy of the work also receives whatever
licenses to the work the party's predecessor in interest had or could
give under the previous paragraph, plus a right to possession of the
Corresponding Source of the work from the predecessor in interest, if
the predecessor has it or can get it with reasonable efforts.
You may not impose any further restrictions on the exercise of the
rights granted or affirmed under this License. For example, you may
not impose a license fee, royalty, or other charge for exercise of
rights granted under this License, and you may not initiate litigation
(including a cross-claim or counterclaim in a lawsuit) alleging that
any patent claim is infringed by making, using, selling, offering for
sale, or importing the Program or any portion of it.
11. Patents.
A "contributor" is a copyright holder who authorizes use under this
License of the Program or a work on which the Program is based. The
work thus licensed is called the contributor's "contributor version".
A contributor's "essential patent claims" are all patent claims
owned or controlled by the contributor, whether already acquired or
hereafter acquired, that would be infringed by some manner, permitted
by this License, of making, using, or selling its contributor version,
but do not include claims that would be infringed only as a
consequence of further modification of the contributor version. For
purposes of this definition, "control" includes the right to grant
patent sublicenses in a manner consistent with the requirements of
this License.
Each contributor grants you a non-exclusive, worldwide, royalty-free
patent license under the contributor's essential patent claims, to
make, use, sell, offer for sale, import and otherwise run, modify and
propagate the contents of its contributor version.
In the following three paragraphs, a "patent license" is any express
agreement or commitment, however denominated, not to enforce a patent
(such as an express permission to practice a patent or covenant not to
sue for patent infringement). To "grant" such a patent license to a
party means to make such an agreement or commitment not to enforce a
patent against the party.
If you convey a covered work, knowingly relying on a patent license,
and the Corresponding Source of the work is not available for anyone
to copy, free of charge and under the terms of this License, through a
publicly available network server or other readily accessible means,
then you must either (1) cause the Corresponding Source to be so
available, or (2) arrange to deprive yourself of the benefit of the
patent license for this particular work, or (3) arrange, in a manner
consistent with the requirements of this License, to extend the patent
license to downstream recipients. "Knowingly relying" means you have
actual knowledge that, but for the patent license, your conveying the
covered work in a country, or your recipient's use of the covered work
in a country, would infringe one or more identifiable patents in that
country that you have reason to believe are valid.
If, pursuant to or in connection with a single transaction or
arrangement, you convey, or propagate by procuring conveyance of, a
covered work, and grant a patent license to some of the parties
receiving the covered work authorizing them to use, propagate, modify
or convey a specific copy of the covered work, then the patent license
you grant is automatically extended to all recipients of the covered
work and works based on it.
A patent license is "discriminatory" if it does not include within
the scope of its coverage, prohibits the exercise of, or is
conditioned on the non-exercise of one or more of the rights that are
specifically granted under this License. You may not convey a covered
work if you are a party to an arrangement with a third party that is
in the business of distributing software, under which you make payment
to the third party based on the extent of your activity of conveying
the work, and under which the third party grants, to any of the
parties who would receive the covered work from you, a discriminatory
patent license (a) in connection with copies of the covered work
conveyed by you (or copies made from those copies), or (b) primarily
for and in connection with specific products or compilations that
contain the covered work, unless you entered into that arrangement,
or that patent license was granted, prior to 28 March 2007.
Nothing in this License shall be construed as excluding or limiting
any implied license or other defenses to infringement that may
otherwise be available to you under applicable patent law.
12. No Surrender of Others' Freedom.
If conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot convey a
covered work so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you may
not convey it at all. For example, if you agree to terms that obligate you
to collect a royalty for further conveying from those to whom you convey
the Program, the only way you could satisfy both those terms and this
License would be to refrain entirely from conveying the Program.
13. Use with the GNU Affero General Public License.
Notwithstanding any other provision of this License, you have
permission to link or combine any covered work with a work licensed
under version 3 of the GNU Affero General Public License into a single
combined work, and to convey the resulting work. The terms of this
License will continue to apply to the part which is the covered work,
but the special requirements of the GNU Affero General Public License,
section 13, concerning interaction through a network will apply to the
combination as such.
14. Revised Versions of this License.
The Free Software Foundation may publish revised and/or new versions of
the GNU General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the
Program specifies that a certain numbered version of the GNU General
Public License "or any later version" applies to it, you have the
option of following the terms and conditions either of that numbered
version or of any later version published by the Free Software
Foundation. If the Program does not specify a version number of the
GNU General Public License, you may choose any version ever published
by the Free Software Foundation.
If the Program specifies that a proxy can decide which future
versions of the GNU General Public License can be used, that proxy's
public statement of acceptance of a version permanently authorizes you
to choose that version for the Program.
Later license versions may give you additional or different
permissions. However, no additional obligations are imposed on any
author or copyright holder as a result of your choosing to follow a
later version.
15. Disclaimer of Warranty.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
16. Limitation of Liability.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.
17. Interpretation of Sections 15 and 16.
If the disclaimer of warranty and limitation of liability provided
above cannot be given local legal effect according to their terms,
reviewing courts shall apply local law that most closely approximates
an absolute waiver of all civil liability in connection with the
Program, unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
state the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
Also add information on how to contact you by electronic and paper mail.
If the program does terminal interaction, make it output a short
notice like this when it starts in an interactive mode:
<program> Copyright (C) <year> <name of author>
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, your program's commands
might be different; for a GUI interface, you would use an "about box".
You should also get your employer (if you work as a programmer) or school,
if any, to sign a "copyright disclaimer" for the program, if necessary.
For more information on this, and how to apply and follow the GNU GPL, see
<http://www.gnu.org/licenses/>.
The GNU General Public License does not permit incorporating your program
into proprietary programs. If your program is a subroutine library, you
may consider it more useful to permit linking proprietary applications with
the library. If this is what you want to do, use the GNU Lesser General
Public License instead of this License. But first, please read
<http://www.gnu.org/philosophy/why-not-lgpl.html>.
MANIFEST.in 0 → 100644
include AUTHORS
include CHANGES
include LICENSE
README 0 → 100644
Aeroo Library
=========
Aeroo Library is a templating library which provides a way to easily output several
kinds of files (odt, ods). Support for more filetypes can be easily added by
creating plugins for them.
Aeroo Library also provides a report repository allowing you to link python objects
and report together, find reports by mimetype/name/python object.
\ No newline at end of file
aeroolib.egg-info/PKG-INFO 0 → 100644
Metadata-Version: 1.1
Name: aeroolib
Version: 1.2.0
Summary: A templating library able to output ODF files
Home-page: http://www.alistek.com/
Author: Alistek Ltd
Author-email: info@alistek.com
License: GPL License
Description-Content-Type: UNKNOWN
Description:
aeroolib
=========
A templating library which provides a way to easily output all kind of
different files (odt, ods). Adding support for more filetype is easy:
you just have to create a plugin for this.
aeroolib also provides a report repository allowing you to link python objects
and report together, find reports by mimetypes/name/python objects.
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License (GPL)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Text Processing
aeroolib.egg-info/SOURCES.txt 0 → 100644
AUTHORS
CHANGES
LICENSE
MANIFEST.in
README
setup.cfg
setup.py
aeroolib/__init__.py
aeroolib/reporting.py
aeroolib.egg-info/PKG-INFO
aeroolib.egg-info/SOURCES.txt
aeroolib.egg-info/dependency_links.txt
aeroolib.egg-info/requires.txt
aeroolib.egg-info/top_level.txt
aeroolib/plugins/__init__.py
aeroolib/plugins/base.py
aeroolib/plugins/opendocument.py
\ No newline at end of file
aeroolib/__init__.py 0 → 100755
"""
Aeroo Library
=========
A templating library which provides a way to easily output all kind of
different files (odt, ods). Adding support for more filetype is
easy: you just have to create a plugin for this.
Is based on Relatorio project
aeroolib also provides a report repository allowing you to link python objects
and report together, find reports by mimetypes/name/python objects.
"""
from aeroolib.reporting import MIMETemplateLoader, ReportRepository, Report
import plugins
__version__ = '1.2.0'
aeroolib/plugins/__init__.py 0 → 100644
##############################################################################
#
# Copyright (c) 2010 Alistek Ltd. (http://www.alistek.com) All Rights
# Reserved.
# General contacts <info@alistek.com>
#
# DISCLAIMER: This module is licensed under GPLv3 or newer and
# is considered incompatible with OpenERP SA "AGPL + Private Use License"!
#
# Copyright (c) 2007, 2008 OpenHex SPRL. (http://openhex.com) All Rights
# Reserved.
#
# WARNING: This program as such is intended to be used by professional
# programmers who take the whole responsability of assessing all potential
# consequences resulting from its eventual inadequacies and bugs
# End users who are looking for a ready-to-use solution with commercial
# garantees and support are strongly adviced to contract a Free Software
# Service Company
#
# This program is Free Software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 3
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
#
##############################################################################
import traceback
import warnings
from cStringIO import StringIO
plugins = ['base', 'opendocument']
for name in plugins:
try:
__import__('aeroolib.plugins.%s' % name)
except Exception, e:
tb_file = StringIO()
print >> tb_file, ("Unable to load plugin '%s', you will not be able "
"to use it" % name)
print >> tb_file
print >> tb_file, 'Original traceback:'
print >> tb_file, '-------------------'
traceback.print_exc(file=tb_file)
print >> tb_file
warnings.warn(tb_file.getvalue())
aeroolib/plugins/base.py 0 → 100644
##############################################################################
#
# Copyright (c) 2012 Alistek Ltd (http://www.alistek.com) All Rights
# Reserved.
# General contacts <info@alistek.com>
#
# DISCLAIMER: This module is licensed under GPLv3 or newer and
# is considered incompatible with OpenERP SA "AGPL + Private Use License"!
#
# Copyright (c) 2007, 2008 OpenHex SPRL. (http://openhex.com) All Rights
# Reserved.
#
# WARNING: This program as such is intended to be used by professional
# programmers who take the whole responsability of assessing all potential
# consequences resulting from its eventual inadequacies and bugs
# End users who are looking for a ready-to-use solution with commercial
# garantees and support are strongly adviced to contract a Free Software
# Service Company
#
# This program is Free Software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 3
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
#
##############################################################################
__metaclass__ = type
from cStringIO import OutputType
import genshi.core
from genshi.template import NewTextTemplate, MarkupTemplate
from aeroolib.reporting import Report, MIMETemplateLoader
class AerooStream(genshi.core.Stream):
"Base class for the aeroo streams."
def render(self, method=None, encoding='utf-8', out=None, **kwargs):
"calls the serializer to render the template"
return self.serializer(self.events)
def serialize(self, method='xml', **kwargs):
"generates the bitstream corresponding to the template"
return self.render(method, **kwargs)
def __or__(self, function):
"Support for the bitwise operator"
return AerooStream(self.events | function, self.serializer)
def __str__(self):
val = self.render()
if isinstance(val, OutputType):
return val.getvalue()
else:
return val
MIMETemplateLoader.add_factory('text', NewTextTemplate)
MIMETemplateLoader.add_factory('xml', MarkupTemplate)
aeroolib/plugins/opendocument.py 0 → 100644
##############################################################################
#
# Copyright (c) 2012 Alistek Ltd (http://www.alistek.com) All Rights
# Reserved.
# General contacts <info@alistek.com>
#
# DISCLAIMER: This module is licensed under GPLv3 or newer and
# is considered incompatible with OpenERP SA "AGPL + Private Use License"!
#
# Copyright (c) 2009 Cedric Krier.
#
# Copyright (c) 2007, 2008 OpenHex SPRL. (http://openhex.com) All Rights
# Reserved.
#
# WARNING: This program as such is intended to be used by professional
# programmers who take the whole responsability of assessing all potential
# consequences resulting from its eventual inadequacies and bugs
# End users who are looking for a ready-to-use solution with commercial
# garantees and support are strongly adviced to contract a Free Software
# Service Company
#
# This program is Free Software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 3
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
#
##############################################################################
__metaclass__ = type
import re
try:
# requires python 2.5+
from hashlib import md5
except ImportError:
from md5 import md5
import time
import urllib
import zipfile
try:
from cStringIO import StringIO
except ImportError:
from StringIO import StringIO
from copy import copy, deepcopy
import warnings
warnings.filterwarnings('always', module='aeroolib.plugins.opendocument')
import lxml.etree
import genshi
import genshi.output
from genshi.template import MarkupTemplate
from genshi.filters import Transformer
from genshi.filters.transform import ENTER, EXIT
from genshi.core import Stream
from genshi.template.interpolation import PREFIX
from aeroolib.plugins.base import AerooStream
from aeroolib.reporting import Report, MIMETemplateLoader
GENSHI_EXPR = re.compile(r'''
(/)? # is this a closing tag?
(for|if|choose|when|otherwise|with|def|match|attrs|content|replace|strip) # tag directive
\s*
(?:\s(\w+)=["'](.*)["']|$) # match a single attr & its value
|
.* # or anything else
''', re.VERBOSE)
EXTENSIONS = {'image/png': 'png',
'image/jpeg': 'jpg',
'image/bmp': 'bmp',
'image/gif': 'gif',
'image/tiff': 'tif',
'image/xbm': 'xbm',
}
AEROO_URI = 'http://alistek.com/'
GENSHI_URI = 'http://genshi.edgewall.org/'
MANIFEST = 'META-INF/manifest.xml'
META = 'meta.xml'
STYLES = 'styles.xml'
output_encode = genshi.output.encode
EtreeElement = lxml.etree.Element
TAB = "[%s]" % md5("&#x9;").hexdigest()
NEW_LINE = "[%s]" % md5("&#xA;").hexdigest()
# A note regarding OpenDocument namespaces:
#
# The current code assumes the original OpenOffice document uses default
# namespace prefix ("table", "xlink", "draw", ...). We derive the actual
# namespaces URIs from their prefix, instead of the other way round. This has
# the advantage that if a new version of the format use different namespaces
# (this is not the case for ODF 1.1 but could be the case in the future since
# there is a version number in those namespaces after all), Aeroo will
# support those new formats out of the box.
# A note about attribute namespaces:
#
# Ideally, we should update the namespace map of all the nodes we add
# (Genshi) attributes to, so that the attributes use a nice "py" prefix instead
# of a generated one (eg. "ns0", which is correct but ugly) in the case no
# parent node defines it. Unfortunately, lxml doesn't support this:
# the nsmap attribute of Element objects is (currently) readonly.
class OOTemplateError(genshi.template.base.TemplateSyntaxError):
"Error to raise when there is a SyntaxError in the genshi template"
class ImageHref:
"A class used to add images in the odf zipfile"
def __init__(self, namespaces, zfile, manifest, context):
self.namespaces = namespaces
self.zip = zfile
self.manifest = manifest
self.context = context.copy()
def __call__(self, expr):
bitstream, mimetype = expr[:2]
if isinstance(bitstream, Report):
bitstream = bitstream(**self.context).render()
bitstream.seek(0)
file_content = bitstream.read()
if len(file_content)>0:
name = md5(file_content).hexdigest()
path = 'Pictures/%s.%s' % (name, EXTENSIONS[mimetype])
if path not in self.zip.namelist():
self.zip.writestr(path, file_content)
self.manifest.add_file_entry(path, mimetype)
if len(expr) == 4:
width, height = expr[2:]
else:
width = height = False
attrs = {'{%s}href' % self.namespaces['xlink']: path}
if width:
attrs['{%s}width' % self.namespaces['svg']] = width
if height:
attrs['{%s}height' % self.namespaces['svg']] = height
return attrs
else:
return {}
class ColumnCounter:
"""A class used to count the actual maximum number of cells (and thus
columns) a table contains accross its rows.
"""
def __init__(self):
self.temp_counters = {}
self.counters = {}
def reset(self, loop_id):
self.temp_counters[loop_id] = 0
def inc(self, loop_id):
self.temp_counters[loop_id] += 1
def store(self, loop_id, table_name):
self.counters[table_name] = max(self.temp_counters.pop(loop_id),
self.counters.get(table_name, 0))
def wrap_nodes_between(first, last, new_parent):
"""An helper function to move all nodes between two nodes to a new node
and add that new node to their former parent. The boundary nodes are
removed in the process.
"""
old_parent = first.getparent()
# Any text after the opening tag (and not within a tag) need to be handled
# explicitly. For example in <if>xxx<span>yyy</span>zzz</if>, zzz is
# copied along the span tag, but not xxx, which corresponds to the tail
# attribute of the opening tag.
if first.tail:
new_parent.text = first.tail
for node in first.itersiblings():
if node is last:
break
# appending a node to a new parent also
# remove it from its previous parent
new_parent.append(node)
old_parent.replace(first, new_parent)
new_parent.tail = last.tail
old_parent.remove(last)
def update_py_attrs(node, value):
"""An helper function to update py_attrs of a node.
"""
if not value:
return
py_attrs_attr = '{%s}attrs' % GENSHI_URI
if not py_attrs_attr in node.attrib:
node.attrib[py_attrs_attr] = value
else:
node.attrib[py_attrs_attr] = \
"(lambda x, y: x.update(y) or x)(%s or {}, %s or {})" % \
(node.attrib[py_attrs_attr], value)
def _filter(val):
if type(val)==bool:
return ''
elif isinstance(val, (str, unicode)):
return val.replace('\t', TAB).replace('\r\n', NEW_LINE).replace('\n', NEW_LINE)
else:
return val
def _hyperlink(namespaces):
def _hyperlink(expr):
attrs = {'{%s}href' % namespaces['xlink']:expr}
return attrs
return _hyperlink
class Template(MarkupTemplate):
def __init__(self, source, serializer, filepath=None, styles=None, filename=None, loader=None,
encoding=None, lookup='strict', allow_exec=True):
self.namespaces = {}
self.inner_docs = []
self.has_col_loop = False
self.Serializer = serializer #OOSerializer(filepath or source, oo_styles=styles)
super(Template, self).__init__(source, filepath, filename, loader,
encoding, lookup, allow_exec)
def _parse(self, source, encoding):
"""parses the odf file.
It adds genshi directives and finds the inner docs.
"""
zf = self.Serializer.inzip
content = self.Serializer.content_xml
styles = self.Serializer.styles_xml
template = super(Template, self)
content = template._parse(self.insert_directives(content), encoding)
styles = template._parse(self.insert_directives(styles), encoding)
content_files = [('content.xml', content)]
styles_files = [('styles.xml', styles)]
while self.inner_docs:
doc = self.inner_docs.pop()
c_path, s_path = doc + '/content.xml', doc + '/styles.xml'
content = zf.read(c_path)
styles = zf.read(s_path)
c_parsed = template._parse(self.insert_directives(content),
encoding)
s_parsed = template._parse(self.insert_directives(styles),
encoding)
content_files.append((c_path, c_parsed))
styles_files.append((s_path, s_parsed))
parsed = []
for fpath, fparsed in content_files + styles_files:
parsed.append((genshi.core.PI, ('aeroo', fpath), None))
parsed += fparsed
return parsed
def insert_directives(self, content):
"""adds the genshi directives, handle the images and the innerdocs.
"""
tree = lxml.etree.parse(StringIO(content))
root = tree.getroot()
# assign default/fake namespaces so that documents do not need to
# define them if they don't use them
self.namespaces = {
"text": "urn:text",
"draw": "urn:draw",
"table": "urn:table",
"office": "urn:office",
"xlink": "urn:xlink",
"svg": "urn:svg",
}
# but override them with the real namespaces
self.namespaces.update(root.nsmap)
# remove any "root" namespace as lxml.xpath do not support them
self.namespaces.pop(None, None)
self.namespaces['py'] = GENSHI_URI
self.namespaces['aeroo'] = AEROO_URI
self._invert_style(tree)
self._handle_aeroo_tags(tree)
self._handle_images(tree)
self._handle_hyperlinks(tree)
self._handle_innerdocs(tree)
self._escape_values(tree)
return StringIO(lxml.etree.tostring(tree))
def _invert_style(self, tree):
"inverts the text:a and text:span"
xpath_expr = "//text:a[starts-with(@xlink:href, 'python://')]" \
"/text:span"
for span in tree.xpath(xpath_expr, namespaces=self.namespaces):
text_a = span.getparent()
outer = text_a.getparent()
text_a.text = span.text
span.text = ''
text_a.remove(span)
outer.replace(text_a, span)
span.append(text_a)
def _aeroo_statements(self, tree):
def check_except_directive( expr):
if GENSHI_EXPR.match(expr).groups()[1] is not None:
return False
return True
"finds the aeroo statements (text:a/text:placeholder)"
# If this node href matches the aeroo URL it is kept.
# If this node href matches a genshi directive it is kept for further
# processing.
xlink_href_attrib = '{%s}href' % self.namespaces['xlink']
text_a = '{%s}a' % self.namespaces['text']
placeholder = '{%s}placeholder' % self.namespaces['text']
text_input = '{%s}text-input' % self.namespaces['text']
s_xpath = "//text:a[starts-with(@xlink:href, 'python://')]" \
"| //text:placeholder" \
"| //text:text-input[starts-with(@text:description, '<') and substring(@text:description, string-length(@text:description))='>']"
r_statements = []
opened_tags = []
# We map each opening tag with its closing tag
closing_tags = {}
dir_sequence = [] # its need for follow syntax checking in template
for statement in tree.xpath(s_xpath, namespaces=self.namespaces):
if statement.tag == placeholder:
if not statement.text:
continue
expr = statement.text[1:-1]
expr = check_except_directive(expr) and "__filter(%s)" % statement.text[1:-1] or expr
elif statement.tag == text_input:
expr = statement.attrib["{%s}description" % self.namespaces['text']][1:-1]
if expr=='_()':
expr = "_('%s')" % statement.text
expr = check_except_directive(expr) and "__filter(%s)" % expr
else:
expr = check_except_directive(expr) and "__filter(%s)" % statement.attrib["{%s}description" % self.namespaces['text']][1:-1] or expr
elif statement.tag == text_a:
expr = urllib.unquote(statement.attrib[xlink_href_attrib][9:])
expr = check_except_directive(expr) and "__filter(%s)" % urllib.unquote(statement.attrib[xlink_href_attrib][9:]) or expr
if not expr:
raise OOTemplateError("No expression in the tag",
self.filepath)
closing, directive, attr, attr_val = \
GENSHI_EXPR.match(expr).groups()
is_opening = closing != '/'
if directive is not None:
dir_sequence.append((directive, expr, is_opening))
# map closing tags with their opening tag
if is_opening:
opened_tags.append(statement)
else:
if not opened_tags:
continue
closing_tags[id(opened_tags.pop())] = statement
# - we only need to return opening statements
if is_opening:
r_statements.append((statement,(expr, directive, attr, attr_val)))
##### Template syntax checking (has no opening/closing tags) #####
check_opening = {}
open_stm_by_type = {}
while(dir_sequence):
directive = dir_sequence.pop()
check_opening.setdefault(directive[0], 0)
if directive[2]: # only for opening tags
if directive[0] not in open_stm_by_type:
open_stm_by_type.setdefault(directive[0], [directive[1]])
else:
open_stm_by_type[directive[0]].append(directive[1])
check_opening[directive[0]] += directive[2] and -1 or 1
for stm in check_opening:
if check_opening[stm]<0: # has no closing tag
error_stm = open_stm_by_type[stm][check_opening[stm]-1]
raise Exception("Statement has no closing tag. <%s>" % error_stm)
if check_opening[stm]>0: # has no opening tag
error_stm = "/%s" % stm
raise Exception("Statement has no opening tag. <%s>" % error_stm)
##################################################################
return r_statements, closing_tags
def _handle_aeroo_tags(self, tree):
"""
Will treat all aeroo tag (py:if/for/choose/when/otherwise)
tags
"""
# Some tag/attribute name constants
table_namespace = self.namespaces['table']
table_row_tag = '{%s}table-row' % table_namespace
table_cell_tag = '{%s}table-cell' % table_namespace
office_name = '{%s}value' % self.namespaces['office']
office_valuetype = '{%s}value-type' % self.namespaces['office']
py_attrs_attr = '{%s}attrs' % GENSHI_URI
py_replace = '{%s}replace' % GENSHI_URI
r_statements, closing_tags = self._aeroo_statements(tree)
for r_node, parsed in r_statements:
expr, directive, attr, a_val = parsed
# If the node is a genshi directive statement:
if directive is not None:
opening = r_node
closing = closing_tags[id(r_node)]
# - we find the nearest common ancestor of the closing and
# opening statements
o_ancestors = [opening]
c_ancestors = [closing] + list(closing.iterancestors())
ancestor = None
for node in opening.iterancestors():
try:
idx = c_ancestors.index(node)
assert c_ancestors[idx] == node
# we only need ancestors up to the common one
del c_ancestors[idx:]
ancestor = node
break
except ValueError:
# c_ancestors.index(node) raise ValueError if node is
# not a child of c_ancestors
pass
o_ancestors.append(node)
assert ancestor is not None, \
"No common ancestor found for opening and closing tag"
outermost_o_ancestor = o_ancestors[-1]
outermost_c_ancestor = c_ancestors[-1]
# handle horizontal repetitions (over columns)
if directive == "for" and ancestor.tag == table_row_tag:
a_val = self._handle_column_loops(parsed, ancestor,
opening,
outermost_o_ancestor,
outermost_c_ancestor)
# - we create a <py:xxx> node
if attr is not None:
attribs = {attr: a_val}
else:
attribs = {}
genshi_node = EtreeElement('{%s}%s' % (GENSHI_URI,
directive),
attrib=attribs,
nsmap={'py': GENSHI_URI})
# - we move all the nodes between the opening and closing
# statements to this new node (append also removes from old
# parent)
# - we replace the opening statement by the <py:xxx> node
# - we delete the closing statement (and its ancestors)
######## This is need for removing only closing genshi tag except other children tags of <p> tag ########
if len(outermost_c_ancestor)>1 and closing in outermost_c_ancestor.getchildren():
outermost_c_ancestor_copy = deepcopy(outermost_c_ancestor)
outermost_c_ancestor.remove(closing)
outermost_c_ancestor.getparent().append(outermost_c_ancestor_copy)
outermost_c_ancestor = outermost_c_ancestor_copy
#########################################################################################################
wrap_nodes_between(outermost_o_ancestor, outermost_c_ancestor, genshi_node)
else:
# It's not a genshi statement it's a python expression
r_node.attrib[py_replace] = expr
parent = r_node.getparent().getparent()
if parent is None or parent.tag != table_cell_tag:
continue
update_py_attrs(parent, "{'guess_type':1}")
def _handle_column_loops(self, statement, ancestor, opening,
outer_o_node, outer_c_node):
_, directive, attr, a_val = statement
self.has_col_loop = True
table_namespace = self.namespaces['table']
table_col_tag = '{%s}table-column' % table_namespace
table_num_col_attr = '{%s}number-columns-repeated' % table_namespace
py_attrs_attr = '{%s}attrs' % GENSHI_URI
repeat_tag = '{%s}repeat' % AEROO_URI
# table node (it is not necessarily the direct parent of ancestor)
table_node = ancestor.iterancestors('{%s}table' % table_namespace) \
.next()
table_name = table_node.attrib['{%s}name' % table_namespace]
# add counting instructions
loop_id = id(opening)
# 1) add reset counter code on the row opening tag
# (through a py:attrs attribute).
# Note that table_name is not needed in the first two
# operations, but a unique id within the table is required
# to support nested column repetition
update_py_attrs(ancestor, "__aeroo_reset_col_count(%d)" % loop_id)
# 2) add increment code (through a py:attrs attribute) on
# the first cell node after the opening (cell node)
# ancestor
enclosed_cell = outer_o_node.getnext()
assert enclosed_cell.tag == '{%s}table-cell' % table_namespace
update_py_attrs(enclosed_cell, "__aeroo_inc_col_count(%d)" %
loop_id)
# 3) add "store count" code as a py:replace node, as the
# last child of the row
attr_value = "__aeroo_store_col_count(%d, %r)" \
% (loop_id, table_name)
replace_node = EtreeElement('{%s}replace' % GENSHI_URI,
attrib={'value': attr_value},
nsmap={'py': GENSHI_URI})
ancestor.append(replace_node)
# find the position in the row of the cells holding the
# <for> and </for> instructions
# We use "*" so as to count both normal cells and covered/hidden cells
position_xpath_expr = 'count(preceding-sibling::*)'
opening_pos = \
int(outer_o_node.xpath(position_xpath_expr,
namespaces=self.namespaces))
closing_pos = \
int(outer_c_node.xpath(position_xpath_expr,
namespaces=self.namespaces))
# check whether or not the opening tag spans several rows
a_val = self._handle_row_spanned_column_loops(
statement, outer_o_node, opening_pos, closing_pos)
# check if this table's headers were already processed
repeat_node = table_node.find(repeat_tag)
if repeat_node is not None:
prev_pos = (int(repeat_node.attrib['opening']),
int(repeat_node.attrib['closing']))
if (opening_pos, closing_pos) != prev_pos:
raise Exception(
'Incoherent column repetition found! '
'If a table has several lines with repeated '
'columns, the repetition need to be on the '
'same columns across all lines.')
else:
# compute splits: oo collapses the headers of adjacent
# columns which use the same style. We need to split
# any column header which is repeated so many times
# that it encompasses any of the column headers that
# we need to repeat
to_split = []
idx = 0
childs = list(table_node.iterchildren(table_col_tag))
for tag in childs:
inc = int(tag.attrib.get(table_num_col_attr, 1))
oldidx = idx
idx += inc
if oldidx < opening_pos < idx or \
oldidx < closing_pos < idx:
to_split.append(tag)
# split tags
for tag in to_split:
tag_pos = table_node.index(tag)
num = int(tag.attrib.pop(table_num_col_attr))
new_tags = [deepcopy(tag) for _ in range(num)]
table_node[tag_pos:tag_pos+1] = new_tags
# recompute the list of column headers as it could
# have changed.
coldefs = list(table_node.iterchildren(table_col_tag))
# compute the column header nodes corresponding to
# the opening and closing tags.
first = table_node[opening_pos]
last = table_node[closing_pos]
# add a <aeroo:repeat> node around the column
# definitions nodes
attribs = {
"opening": str(opening_pos),
"closing": str(closing_pos),
"table": table_name
}
repeat_node = EtreeElement(repeat_tag, attrib=attribs,
nsmap={'aeroo': AEROO_URI})
wrap_nodes_between(first, last, repeat_node)
return a_val
def _handle_row_spanned_column_loops(self, statement, outer_o_node,
opening_pos, closing_pos):
"""handles column repetitions which span several rows, by duplicating
the py:for node for each row, and make the loops work on a copy of the
original iterable as to not exhaust generators."""
_, directive, attr, a_val = statement
table_namespace = self.namespaces['table']
table_rowspan_attr = '{%s}number-rows-spanned' % table_namespace
# checks wether there is a (meaningful) rowspan
rows_spanned = int(outer_o_node.attrib.get(table_rowspan_attr, 1))
if rows_spanned == 1:
return a_val
table_row_tag = '{%s}table-row' % table_namespace
table_cov_cell_tag = '{%s}covered-table-cell' % table_namespace
# if so, we need to:
# 1) create a with node to define a temporary variable
temp_var = "__aeroo_temp%d" % id(outer_o_node)
# a_val == "target in iterable"
target, iterable = a_val.split(' in ', 1)
vars = "%s = list(%s)" % (temp_var, iterable.strip())
with_node = EtreeElement('{%s}with' % GENSHI_URI,
attrib={"vars": vars},
nsmap={'py': GENSHI_URI})
# 2) transform a_val to use that temporary variable
a_val = "%s in %s" % (target, temp_var)
# 3) wrap the corresponding cells on the next row(s)
# (those should be covered-table-cell) inside a
# duplicate py:for node (looping on the temporary
# variable).
row_node = outer_o_node.getparent()
row_node.addprevious(with_node)
rows_to_wrap = [row_node]
assert row_node.tag == table_row_tag
next_rows = row_node.itersiblings(table_row_tag)
for row_idx in range(rows_spanned-1):
next_row_node = next_rows.next()
rows_to_wrap.append(next_row_node)
# compute the start and end nodes
first = next_row_node[opening_pos]
last = next_row_node[closing_pos]
assert first.tag == table_cov_cell_tag
assert last.tag == table_cov_cell_tag
# wrap them
tag = '{%s}%s' % (GENSHI_URI, directive)
for_node = EtreeElement(tag,
attrib={attr: a_val},
nsmap={'py': GENSHI_URI})
wrap_nodes_between(first, last, for_node)
# 4) wrap all the corresponding rows indide the "with"
# node
for node in rows_to_wrap:
with_node.append(node)
return a_val
def _handle_images(self, tree):
"replaces all draw:frame named 'image: ...' by draw:image nodes"
draw_namespace = self.namespaces['draw']
draw_name = '{%s}name' % draw_namespace
draw_image = '{%s}image' % draw_namespace
py_attrs = '{%s}attrs' % self.namespaces['py']
svg_namespace = self.namespaces['svg']
svg_width = '{%s}width' % svg_namespace
svg_height = '{%s}height' % svg_namespace
xpath_expr = "//draw:frame[starts-with(@draw:name, 'image:')]"
for draw in tree.xpath(xpath_expr, namespaces=self.namespaces):
d_name = draw.attrib[draw_name][6:].strip()
draw.attrib[draw_name] = "Aeroo picture "
attr_expr = "__aeroo_make_href(%s)" % d_name
image_node = EtreeElement(draw_image,
attrib={py_attrs: attr_expr},
nsmap={'draw': draw_namespace,
'py': GENSHI_URI})
draw.replace(draw[0], image_node)
def _handle_hyperlinks(self, tree):
xpath_href_expr = "//draw:a[starts-with(@xlink:href, 'python://')] | //text:a[starts-with(@xlink:href, 'pythonuri://')]"
href_attrib = '{%s}href' % self.namespaces['xlink']
py_attrs = '{%s}attrs' % self.namespaces['py']
for a in tree.xpath(xpath_href_expr, namespaces=self.namespaces):
a.attrib[py_attrs] = "__aeroo_hyperlink(%s)" % urllib.unquote(a.attrib[href_attrib]).replace('python://','').replace('pythonuri://','')#[9:]
del a.attrib[href_attrib]
def _handle_innerdocs(self, tree):
"finds inner_docs and adds them to the processing stack."
href_attrib = '{%s}href' % self.namespaces['xlink']
xpath_expr = "//draw:object[starts-with(@xlink:href, './')" \
"and @xlink:show='embed']"
for draw in tree.xpath(xpath_expr, namespaces=self.namespaces):
self.inner_docs.append(draw.attrib[href_attrib][2:])
def _escape_values(self, tree):
"escapes element values"
for element in tree.iter():
for attrs in element.keys():
if not attrs.startswith('{%s}' % GENSHI_URI):
element.attrib[attrs] = element.attrib[attrs]\
.replace(PREFIX, PREFIX * 2)
if element.text:
element.text = element.text.replace(PREFIX, PREFIX * 2)
def generate(self, *args, **kwargs):
"creates the AerooStream."
#serializer = OOSerializer(self.filepath)
self.Serializer.new_oo = StringIO()
outzip = zipfile.ZipFile(self.Serializer.new_oo, 'w')
self.Serializer.outzip = outzip
kwargs['__aeroo_make_href'] = ImageHref(self.namespaces, outzip, self.Serializer.manifest, kwargs)
kwargs['__aeroo_hyperlink'] = _hyperlink(self.namespaces)
if '__filter' not in kwargs:
kwargs['__filter'] = _filter
counter = ColumnCounter()
kwargs['__aeroo_reset_col_count'] = counter.reset
kwargs['__aeroo_inc_col_count'] = counter.inc
kwargs['__aeroo_store_col_count'] = counter.store
stream = super(Template, self).generate(*args, **kwargs)
if self.has_col_loop:
# Note that we can't simply add a "number-columns-repeated"
# attribute and then fill it with the correct number of columns
# because that wouldn't work if more than one column is repeated.
transformation = DuplicateColumnHeaders(counter)
col_filter = Transformer('//repeat[namespace-uri()="%s"]'
% AEROO_URI)
col_filter = col_filter.apply(transformation)
stream = Stream(list(stream), self.serializer) | col_filter
return AerooStream(stream, self.Serializer)
class DuplicateColumnHeaders(object):
def __init__(self, counter):
self.counter = counter
def __call__(self, stream):
for mark, (kind, data, pos) in stream:
# for each repeat tag found
if mark is ENTER:
# get the number of columns for that table
attrs = data[1]
table = attrs.get('table')
col_count = self.counter.counters[table]
# collect events (column header tags) to repeat
events = []
for submark, event in stream:
if submark is EXIT:
break
events.append(event)
# repeat them
for _ in range(col_count):
for event in events:
yield None, event
else:
yield mark, (kind, data, pos)
class Manifest(object):
def __init__(self, content):
self.tree = lxml.etree.parse(StringIO(content))
self.root = self.tree.getroot()
self.namespaces = self.root.nsmap
for el in filter(lambda child: child.tag=="{%s}file-entry" % self.namespaces['manifest'], self.root.iterchildren()):
if filter(lambda a: a[0]=='{%s}full-path' % self.namespaces['manifest'] and a[1].startswith("Thumbnails"), el.items()):
self.root.remove(el)
def __str__(self):
return lxml.etree.tostring(self.tree, encoding='UTF-8',
xml_declaration=True)
def add_file_entry(self, path, mimetype=None):
manifest_namespace = self.namespaces['manifest']
attribs = {'{%s}media-type' % manifest_namespace: mimetype or '',
'{%s}full-path' % manifest_namespace: path}
entry_node = EtreeElement('{%s}%s' % (manifest_namespace,
'file-entry'),
attrib=attribs,
nsmap={'manifest': manifest_namespace})
self.root.append(entry_node)
class Meta(object):
def __init__(self, content):
self.tree = lxml.etree.parse(StringIO(content))
self.root = self.tree.getroot()
self.namespaces = self.root.nsmap
self.meta_root = self.root.getchildren()[0]
self.add_entry('editing-cycles', 'meta', '1')
self.add_entry('editing-duration', 'meta', '')
def __str__(self):
return lxml.etree.tostring(self.tree, encoding='UTF-8',
xml_declaration=True)
def add_entry(self, tag_name, namespace, data=None, attribs={}):
meta_namespace = self.namespaces['meta']
entry_node = self.meta_root.find('{%s}%s' % (self.namespaces[namespace],tag_name))
if entry_node is None:
entry_node = EtreeElement('{%s}%s' % (self.namespaces[namespace],tag_name),
nsmap={'meta': meta_namespace},
attrib=attribs)
self.meta_root.append(entry_node)
else:
entry_node.attrib.update(attribs)
entry_node.text = data
def add_property(self, data=None, ptype=''):
meta_namespace = self.namespaces['meta']
entry_node = EtreeElement('{%s}%s' % (self.namespaces['meta'],'user-defined'),
nsmap={'meta': meta_namespace},
attrib={'{%s}name' % self.namespaces['meta']:ptype})
self.meta_root.append(entry_node)
entry_node.text = data
class TStyle(object):
def __init__(self, content):
self.tree = lxml.etree.parse(StringIO(content))
self.root = self.tree.getroot()
self.namespaces = self.root.nsmap
def __str__(self):
return lxml.etree.tostring(self.tree, encoding='UTF-8',
xml_declaration=True)
class TContent(object):
def __init__(self, content):
self.tree = lxml.etree.parse(StringIO(content))
self.root = self.tree.getroot()
self.namespaces = self.root.nsmap
ns = lxml.etree.FunctionNamespace(None)
def __str__(self):
return lxml.etree.tostring(self.tree, encoding='UTF-8',
xml_declaration=True)
class OOSerializer:
def __init__(self, oo_template, oo_styles=None):
self.template = oo_template
self.inzip = zipfile.ZipFile(self.template)
self.manifest = Manifest(self.inzip.read(MANIFEST))
self.meta = Meta(self.inzip.read(META))
self.content_xml = self.inzip.read('content.xml')
self.styles_xml = self.inzip.read('styles.xml')
self.apply_style(oo_styles)
self.new_oo = None
self.xml_serializer = genshi.output.XMLSerializer()
def check_tabs(self, tree, namespaces):
tags = tree.xpath("//text:*/text()[contains(string(), '%s')]/.." % TAB, namespaces=namespaces)
for tag in tags:
children = tag.getchildren()
if tag.text:
tabs_text=tag.text.split(TAB)
tag.text=tabs_text.pop(0)
pos = 0
for text in tabs_text:
new_node = EtreeElement('{%s}tab' % namespaces['text'],
attrib={},
nsmap=namespaces)
new_node.tail=text
tag.insert(pos,new_node)
pos += 1
else:
new_node = EtreeElement('{%s}tab' % namespaces['text'],
attrib=tag.attrib,
nsmap=namespaces)
tag.addnext(new_node)
for child in tag.iterchildren():
if not child.tail:
continue
child_tail = child.tail
child.tail = ''
tail_text = child_tail.split(TAB)
n = len(tail_text)-1
while n:
new_node = EtreeElement('{%s}tab' % namespaces['text'],
attrib={},
nsmap=namespaces)
child.addnext(new_node)
n -= 1
child.tail = tail_text.pop(0)
last_node = child.getnext()
for text in tail_text:
last_node.tail = text
last_node = last_node.getnext()
def check_spaces(self, tree, namespaces):
tags = tree.xpath("//text:*[starts-with(text(), ' ') or substring(name(),string-length(name())-1)=' ']", namespaces=namespaces)
for tag in tags:
children = tag.getchildren()
if tag.text:
tabs_text=tag.text.split(' ')
tag.text=tabs_text.pop(0)
pos = 0
for text in tabs_text:
new_node = EtreeElement('{%s}s' % namespaces['text'],
attrib={},
nsmap=namespaces)
new_node.tail=text
tag.insert(pos,new_node)
pos += 1
else:
new_node = EtreeElement('{%s}s' % namespaces['text'],
attrib=tag.attrib,
nsmap=namespaces)
tag.addnext(new_node)
for child in tag.iterchildren():
if not child.tail:
continue
child_tail = child.tail
child.tail = ''
tail_text = child_tail.split(' ')
n = len(tail_text)-1
while n:
new_node = EtreeElement('{%s}s' % namespaces['text'],
attrib={},
nsmap=namespaces)
child.addnext(new_node)
n -= 1
child.tail = tail_text.pop(0)
last_node = child.getnext()
for text in tail_text:
last_node.tail = text
last_node = last_node.getnext()
def check_new_lines(self, tree, namespaces):
#tags = tree.xpath("//text:*[contains(text(), '%s')]" % NEW_LINE, namespaces=namespaces)
#tags = tree.xpath("//text:*[text()[contains(., '%s')]]" % NEW_LINE, namespaces=namespaces)
span_tags = tree.xpath("//text:span[text()[contains(., '%s')]]" % NEW_LINE, namespaces=namespaces)
tags = tree.xpath("//text:*[text()[contains(., '%s')]]" % NEW_LINE, namespaces=namespaces)
tags = list(set(tags)-set(span_tags))
#tags = tree.xpath("//text:*[text()[contains(., '%s')]]" % NEW_LINE, namespaces=namespaces)
for tag in tags:
children = tag.getchildren()
if tag.text:
for text in tag.text.split(NEW_LINE):
new_node = EtreeElement('%s' % tag.tag,
attrib=tag.attrib,
nsmap=namespaces)
new_node.text=text
tag.addprevious(new_node)
last_node=new_node
else:
new_node = EtreeElement('%s' % tag.tag,
attrib=tag.attrib,
nsmap=namespaces)
last_node = new_node
tag.addnext(new_node)
if children:
for child in children:
if tag.text and tag.text.endswith(NEW_LINE):
new_node = EtreeElement('%s' % tag.tag,
attrib=tag.attrib,
nsmap=namespaces)
new_node.append(child)
last_node.addnext(new_node)
last_node = new_node
last_child = None
else:
last_node.append(child)
last_child = child
if not child.tail:
continue
child_tail = child.tail
child.tail = ''
tail_text = child_tail.split(NEW_LINE)
if tail_text[0] is not None and last_child is not None:
last_child.tail = tail_text.pop(0)
for text in tail_text:
new_node = EtreeElement('%s' % tag.tag,
attrib=tag.attrib,
nsmap=namespaces)
new_node.text=text
last_node.addnext(new_node)
last_node = new_node
if tag.text:
tag.getparent().remove(tag)
for tag in span_tags:
if tag.tag=='{%s}span' % namespaces['text']:
span_texts = tag.text.split(NEW_LINE)
parent = tag.getparent()
parent_attrib = parent.attrib
parent_children = parent.iterchildren()
parent_itertext = parent.itertext()
parent_text = parent.text
parent_tail = parent.tail
new_parent_node = EtreeElement('%s' % parent.tag,
attrib=parent_attrib,
nsmap=namespaces)
parent.getparent().replace(parent, new_parent_node)
new_parent_node.text = parent_text
new_parent_node.tail = parent_tail
next_child = new_parent_node
try:
while(True):
curr_child = parent_children.next()
if curr_child.tag=='{%s}span' % namespaces['text'] and tag.text==curr_child.text:
new_span_node = EtreeElement('{%s}span' % namespaces['text'],
attrib=tag.attrib,
nsmap=namespaces)
new_span_node.text = span_texts.pop(0)
next_child.append(new_span_node)
curr_child = next_child
for text in span_texts:
new_node = EtreeElement('%s' % parent.tag,
attrib=parent_attrib,
nsmap=namespaces)
new_span_node = EtreeElement('{%s}span' % namespaces['text'],
attrib=tag.attrib,
nsmap=namespaces)
new_span_node.text=text
new_node.append(new_span_node)
curr_child.addnext(new_node)
curr_child = new_node
new_span_node.tail = tag.tail # set tail of source node in tail of latest new node
break
else:
next_child.append(curr_child)
except StopIteration:
pass
try:
next_text = True
while(next_text):
next_child = parent_children.next()
curr_child.append(next_child)
next_text = next_child.text
except StopIteration:
pass
try:
while(True):
next_child = parent_children.next()
if not next_child.text:
curr_child.append(next_child)
else:
new_node = EtreeElement('%s' % parent.tag,
attrib=parent_attrib,
nsmap=namespaces)
new_node.append(next_child)
curr_child.addnext(new_node)
curr_child = new_node
if next_child.tail:
next_child_texts = next_child.tail.split(NEW_LINE)
next_child.tail = next_child_texts.pop(0)
for next_text in next_child_texts:
new_node = EtreeElement('%s' % parent.tag,
attrib=parent_attrib,
nsmap=namespaces)
new_node.text=next_text
curr_child.addnext(new_node)
curr_child = new_node
except StopIteration:
pass
def check_guess_type(self, tree, namespaces):
tags = tree.xpath('//table:table-cell[@guess_type]', namespaces=namespaces)
for tag in tags:
if len(tag)==0 or len(tag)>1 or tag[0].getchildren():
guess_type = 'string'
else:
try:
float(tag[0].text)
guess_type = 'float'
tag.attrib['{%s}value' % namespaces['office']] = tag[0].text
except (ValueError,TypeError):
guess_type = 'string'
tag.attrib['{%s}value-type' % namespaces['office']] = guess_type
del tag.attrib['guess_type']
def check_images(self, tree, namespaces):
tags = tree.xpath('//draw:frame/draw:image[@svg:height and @svg:width]', namespaces=namespaces)
for tag in tags:
height = tag.attrib['{%s}height' % namespaces['svg']]
width = tag.attrib['{%s}width' % namespaces['svg']]
del tag.attrib['{%s}height' % namespaces['svg']]
del tag.attrib['{%s}width' % namespaces['svg']]
tag.getparent().attrib.update({'{%s}height' % namespaces['svg']:height,
'{%s}width' % namespaces['svg']:width})
def apply_style(self, oo_styles):
if oo_styles:
self.styles_zip = zipfile.ZipFile(oo_styles)
self.styles_new = TStyle(self.styles_zip.read(STYLES))
self.styles_new_xml = str(self.styles_new)
self.styles = TStyle(self.inzip.read(STYLES))
##### font-face #####
font_face_new = self.styles_new.root.xpath('//office:font-face-decls/style:font-face', \
namespaces=self.styles_new.namespaces)
font_face_orig = self.styles.root.xpath('//office:font-face-decls/style:font-face', \
namespaces=self.styles.namespaces)
self._replace_style_by_attrib(font_face_new, font_face_orig, 'name', self.styles.namespaces['style'])
###### styles ######
new_styles = self.styles_new.root.xpath('//office:styles/style:style', \
namespaces=self.styles_new.namespaces)
orig_styles = self.styles.root.xpath('//office:styles/style:style', \
namespaces=self.styles.namespaces)
self._replace_style_by_attrib(new_styles, orig_styles, 'name', self.styles.namespaces['style'])
##### master-styles #####
new_master_page_styles = self.styles_new.root.xpath('//office:master-styles/style:master-page', namespaces=self.styles_new.namespaces)#[0]
orig_master_page_styles = self.styles.root.xpath('//office:master-styles/style:master-page', namespaces=self.styles.namespaces)#[0]
self._replace_style_by_attrib(new_master_page_styles, orig_master_page_styles, 'name', self.styles.namespaces['style'])
##### automatic-styles #####
new_automatic_page_styles = self.styles_new.root.xpath('//office:automatic-styles/style:style', namespaces=self.styles_new.namespaces)#[0]
orig_automatic_page_styles = self.styles.root.xpath('//office:automatic-styles/style:style', namespaces=self.styles.namespaces)#[0]
if orig_automatic_page_styles:
self._replace_style_by_attrib(new_automatic_page_styles, orig_automatic_page_styles, 'name', self.styles.namespaces['style'])
else:
dest_node = self.styles.root.xpath('//office:automatic-styles', namespaces=self.styles_new.namespaces)[0]
self._add_styles(new_automatic_page_styles, dest_node)
new_page_layout = self.styles_new.root.xpath('//office:automatic-styles/style:page-layout', \
namespaces=self.styles_new.namespaces)
orig_page_layout = self.styles.root.xpath('//office:automatic-styles/style:page-layout', \
namespaces=self.styles.namespaces)
self._replace_style_by_attrib(new_page_layout, orig_page_layout, 'name', self.styles.namespaces['style'])
###########################
self.styles_xml = str(self.styles)
def add_title(self, title):
self.meta.add_entry('title', 'dc', title)
def add_creation_date(self, date):
self.meta.add_entry('date', 'dc', date)
self.meta.add_entry('creation-date', 'meta', date)
def add_creation_user(self, user):
self.meta.add_entry('creator', 'dc', user)
def add_generator_info(self, data):
self.meta.add_entry('generator', 'meta', data)
def add_custom_property(self, data, ptype):
self.meta.add_property(data, ptype)
def _add_styles(self, node_list, dest_node):
for node in node_list:
dest_node.append(deepcopy(node))
return dest_node
def _replace_style_by_attrib(self, node_list1, node_list2, name, namespace):
for node1 in node_list1:
#curr_node = filter(lambda node: node.get('{%s}%s' % (namespace,name))==node1.get('{%s}%s' % (namespace,name)), node_list2)
curr_node = None
node_to_update = []
for node2 in node_list2:
if node2.get('{%s}%s' % (namespace,name))==node1.get('{%s}%s' % (namespace,name)):
curr_node = node2
node_to_update.append(node2)
break
if curr_node is not None and curr_node.getchildren():
#curr_node=curr_node[0]
for child_node in curr_node.iterchildren():
curr_node.attrib.update(dict(node1.attrib))
orig_node = node1.find(child_node.tag)
if orig_node is not None:
new_attribs = dict(child_node.attrib)
new_attribs.update(orig_node.attrib)
new_child_node = EtreeElement(child_node.tag, attrib=new_attribs)
new_child_node.append(deepcopy(child_node))
orig_subchildren = orig_node.getchildren()
if orig_subchildren:
self._add_styles(orig_subchildren, new_child_node)
curr_node.replace(child_node, new_child_node)
node1.remove(orig_node)
if node1 is not None:
self._add_styles(node1, curr_node)
else:
node_list2[0].getparent().append(deepcopy(node1))
return node_list2
def __call__(self, stream):
files = {}
for kind, data, pos in stream:
if kind == genshi.core.PI and data[0] == 'aeroo':
stream_for = data[1]
continue
files.setdefault(stream_for, []).append((kind, data, pos))
now = time.localtime()[:6]
outzip = self.outzip
self.template.seek(0)
inzip = zipfile.ZipFile(StringIO(self.template.read()))
for f_info in inzip.infolist():
if f_info.filename.startswith('ObjectReplacements'):
continue
elif f_info.filename in files:
stream = files[f_info.filename]
# create a new file descriptor, copying some attributes from
# the original file
new_info = zipfile.ZipInfo(f_info.filename, now)
for attr in ('compress_type', 'flag_bits', 'create_system'):
setattr(new_info, attr, getattr(f_info, attr))
serialized_stream = output_encode(self.xml_serializer(stream), encoding='utf-8')
############### Styles usage #################
if f_info.filename == STYLES:
self.styles_orig = TStyle(serialized_stream)
self.check_guess_type(self.styles_orig.tree, self.styles_orig.namespaces)
self.check_images(self.styles_orig.tree, self.styles_orig.namespaces)
self.check_new_lines(self.styles_orig.tree, self.styles_orig.namespaces)
self.check_tabs(self.styles_orig.tree, self.styles_orig.namespaces)
self.check_spaces(self.styles_orig.tree, self.styles_orig.namespaces)
if hasattr(self, 'styles_new'):
pictures = []
for file_name in self.styles_zip.namelist():
if file_name.startswith('Pictures'):
picture = self.styles_zip.read(file_name)
pictures.append((file_name, picture))
self.manifest.add_file_entry(file_name)
for ffile, picture in pictures:
outzip.writestr(ffile, picture)
outzip.writestr(new_info, str(self.styles_orig))
###############################################
elif f_info.filename == 'content.xml':
content = TContent(serialized_stream)
self.check_guess_type(content.tree, content.namespaces)
self.check_images(content.tree, content.namespaces)
self.check_new_lines(content.tree, content.namespaces)
self.check_tabs(content.tree, content.namespaces)
self.check_spaces(content.tree, content.namespaces)
outzip.writestr(new_info, str(content))
else:
outzip.writestr(new_info, serialized_stream)
elif f_info.filename == MANIFEST:
outzip.writestr(f_info, str(self.manifest))
elif f_info.filename == META:
outzip.writestr(f_info, str(self.meta))
elif f_info.filename=='Thumbnails/thumbnail.png':
continue
else:
outzip.writestr(f_info, inzip.read(f_info.filename))
inzip.close()
outzip.close()
return self.new_oo is not None and self.new_oo or StringIO()
MIMETemplateLoader.add_factory('oo.org', Template)
aeroolib/reporting.py 0 → 100755
##############################################################################
#
# Copyright (c) 2010 Alistek Ltd. (http://www.alistek.com) All Rights
# Reserved.
# General contacts <info@alistek.com>
#
# DISCLAIMER: This module is licensed under GPLv3 or newer and
# is considered incompatible with OpenERP SA "AGPL + Private Use License"!
#
# Copyright (c) 2007, 2008 OpenHex SPRL. (http://openhex.com) All Rights
# Reserved.
#
# WARNING: This program as such is intended to be used by professional
# programmers who take the whole responsability of assessing all potential
# consequences resulting from its eventual inadequacies and bugs
# End users who are looking for a ready-to-use solution with commercial
# garantees and support are strongly adviced to contract a Free Software
# Service Company
#
# This program is Free Software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 3
# of the License, or (at your option) any later version.
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
#
##############################################################################
__metaclass__ = type
import os, sys
import pkg_resources
from genshi.template import TemplateLoader
def _absolute(path):
"Compute the absolute path of path relative to the caller file"
if os.path.isabs(path):
return path
caller_fname = sys._getframe(2).f_globals['__file__']
caller_dir = os.path.dirname(caller_fname)
return os.path.abspath(os.path.join(caller_dir, path))
def _guess_type(mime):
"""
Returns the codename used by aeroolib to identify which template plugin
it should use to render a mimetype
"""
mime = mime.lower()
major, stype = mime.split('/', 1)
if major == 'application':
if 'opendocument' in stype:
return 'oo.org'
else:
return stype
elif major == 'text':
if stype in ('xml', 'html', 'xhtml'):
return 'markup'
else:
return 'text'
class MIMETemplateLoader(TemplateLoader):
"""This subclass of TemplateLoader use mimetypes to search and find
templates to load.
"""
factories = {}
mime_func = [_guess_type]
def get_type(self, mime):
"finds the codename used by aeroolib to work on a mimetype"
for func in reversed(self.mime_func):
codename = func(mime)
if codename is not None:
return codename
def load(self, path, mime=None, relative_to=None, cls=None):
"returns a template object based on path"
assert mime is not None or cls is not None
if mime is not None:
cls = self.factories[self.get_type(mime)]
return super(MIMETemplateLoader, self).load(
path, cls=cls, relative_to=relative_to)
@classmethod
def add_factory(cls, abbr_mimetype, template_factory, id_function=None):
"""adds a template factory to the already known factories"""
cls.factories[abbr_mimetype] = template_factory
if id_function is not None:
cls.mime_func.append(id_function)
default_loader = MIMETemplateLoader(auto_reload=True)
class DefaultFactory:
"""This is the default factory used by aeroolib.
It just returns a copy of the data it receives"""
def __init__(self, *args, **kwargs):
pass
def __call__(self, **kwargs):
data = kwargs.copy()
return data
default_factory = DefaultFactory()
class Report:
"""Report is a simple interface on top of a rendering template.
"""
def __init__(self, path, mimetype,
factory=default_factory, loader=default_loader):
self.fpath = path
self.mimetype = mimetype
self.data_factory = factory
self.tmpl_loader = loader
self.filters = []
def __call__(self, **kwargs):
template = self.tmpl_loader.load(self.fpath, self.mimetype)
data = self.data_factory(**kwargs)
return template.generate(**data).filter(*self.filters)
def __repr__(self):
return '<aeroo report on %s>' % self.fpath
class ReportDict:
def __init__(self, *args, **kwargs):
self.mimetypes = {}
self.ids = {}
class ReportRepository:
"""ReportRepository stores the report definition associated to objects.
The report are indexed in this object by the object class they are working
on and the name given to it by the user.
"""
def __init__(self, datafactory=DefaultFactory):
self.classes = {}
self.default_factory = datafactory
self.loader = default_loader
def add_report(self, klass, mimetype, template_path, data_factory=None,
report_name='default', description=''):
"""adds a report to the repository.
You will be able to find the report via
- the class it is working on
- the mimetype it outputs
- the name of the report
You also have the opportunity to define a specific data_factory.
"""
if data_factory is None:
data_factory = self.default_factory
reports = self.classes.setdefault(klass, ReportDict())
report = Report(_absolute(template_path), mimetype,
data_factory(klass, mimetype), self.loader)
reports.ids[report_name] = report, mimetype, description
reports.mimetypes.setdefault(mimetype, []) \
.append((report, report_name))
def by_mime(self, klass, mimetype):
"""gets a list of report related to a class by specifying the mimetype
"""
return self.classes[klass].mimetypes[mimetype]
def by_id(self, klass, id):
"""get a report related to a class by its id
"""
return self.classes[klass].ids[id]
build/lib.linux-x86_64-2.7/aeroolib/__init__.py 0 → 100644
"""
Aeroo Library
=========
A templating library which provides a way to easily output all kind of
different files (odt, ods). Adding support for more filetype is
easy: you just have to create a plugin for this.
Is based on Relatorio project
aeroolib also provides a report repository allowing you to link python objects
and report together, find reports by mimetypes/name/python objects.
"""
from aeroolib.reporting import MIMETemplateLoader, ReportRepository, Report
import plugins
__version__ = '1.2.0'
build/lib.linux-x86_64-2.7/aeroolib/plugins/__init__.py 0 → 100644
##############################################################################
#
# Copyright (c) 2010 Alistek Ltd. (http://www.alistek.com) All Rights
# Reserved.
# General contacts <info@alistek.com>
#
# DISCLAIMER: This module is licensed under GPLv3 or newer and
# is considered incompatible with OpenERP SA "AGPL + Private Use License"!
#
# Copyright (c) 2007, 2008 OpenHex SPRL. (http://openhex.com) All Rights
# Reserved.
#
# WARNING: This program as such is intended to be used by professional
# programmers who take the whole responsability of assessing all potential
# consequences resulting from its eventual inadequacies and bugs
# End users who are looking for a ready-to-use solution with commercial
# garantees and support are strongly adviced to contract a Free Software
# Service Company
#
# This program is Free Software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 3
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
#
##############################################################################
import traceback
import warnings
from cStringIO import StringIO
plugins = ['base', 'opendocument']
for name in plugins:
try:
__import__('aeroolib.plugins.%s' % name)
except Exception, e:
tb_file = StringIO()
print >> tb_file, ("Unable to load plugin '%s', you will not be able "
"to use it" % name)
print >> tb_file
print >> tb_file, 'Original traceback:'
print >> tb_file, '-------------------'
traceback.print_exc(file=tb_file)
print >> tb_file
warnings.warn(tb_file.getvalue())
build/lib.linux-x86_64-2.7/aeroolib/plugins/base.py 0 → 100644
##############################################################################
#
# Copyright (c) 2012 Alistek Ltd (http://www.alistek.com) All Rights
# Reserved.
# General contacts <info@alistek.com>
#
# DISCLAIMER: This module is licensed under GPLv3 or newer and
# is considered incompatible with OpenERP SA "AGPL + Private Use License"!
#
# Copyright (c) 2007, 2008 OpenHex SPRL. (http://openhex.com) All Rights
# Reserved.
#
# WARNING: This program as such is intended to be used by professional
# programmers who take the whole responsability of assessing all potential
# consequences resulting from its eventual inadequacies and bugs
# End users who are looking for a ready-to-use solution with commercial
# garantees and support are strongly adviced to contract a Free Software
# Service Company
#
# This program is Free Software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 3
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
#
##############################################################################
__metaclass__ = type
from cStringIO import OutputType
import genshi.core
from genshi.template import NewTextTemplate, MarkupTemplate
from aeroolib.reporting import Report, MIMETemplateLoader
class AerooStream(genshi.core.Stream):
"Base class for the aeroo streams."
def render(self, method=None, encoding='utf-8', out=None, **kwargs):
"calls the serializer to render the template"
return self.serializer(self.events)
def serialize(self, method='xml', **kwargs):
"generates the bitstream corresponding to the template"
return self.render(method, **kwargs)
def __or__(self, function):
"Support for the bitwise operator"
return AerooStream(self.events | function, self.serializer)
def __str__(self):
val = self.render()
if isinstance(val, OutputType):
return val.getvalue()
else:
return val
MIMETemplateLoader.add_factory('text', NewTextTemplate)
MIMETemplateLoader.add_factory('xml', MarkupTemplate)
build/lib.linux-x86_64-2.7/aeroolib/plugins/opendocument.py 0 → 100644
##############################################################################
#
# Copyright (c) 2012 Alistek Ltd (http://www.alistek.com) All Rights
# Reserved.
# General contacts <info@alistek.com>
#
# DISCLAIMER: This module is licensed under GPLv3 or newer and
# is considered incompatible with OpenERP SA "AGPL + Private Use License"!
#
# Copyright (c) 2009 Cedric Krier.
#
# Copyright (c) 2007, 2008 OpenHex SPRL. (http://openhex.com) All Rights
# Reserved.
#
# WARNING: This program as such is intended to be used by professional
# programmers who take the whole responsability of assessing all potential
# consequences resulting from its eventual inadequacies and bugs
# End users who are looking for a ready-to-use solution with commercial
# garantees and support are strongly adviced to contract a Free Software
# Service Company
#
# This program is Free Software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 3
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
#
##############################################################################
__metaclass__ = type
import re
try:
# requires python 2.5+
from hashlib import md5
except ImportError:
from md5 import md5
import time
import urllib
import zipfile
try:
from cStringIO import StringIO
except ImportError:
from StringIO import StringIO
from copy import copy, deepcopy
import warnings
warnings.filterwarnings('always', module='aeroolib.plugins.opendocument')
import lxml.etree
import genshi
import genshi.output
from genshi.template import MarkupTemplate
from genshi.filters import Transformer
from genshi.filters.transform import ENTER, EXIT
from genshi.core import Stream
from genshi.template.interpolation import PREFIX
from aeroolib.plugins.base import AerooStream
from aeroolib.reporting import Report, MIMETemplateLoader
GENSHI_EXPR = re.compile(r'''
(/)? # is this a closing tag?
(for|if|choose|when|otherwise|with|def|match|attrs|content|replace|strip) # tag directive
\s*
(?:\s(\w+)=["'](.*)["']|$) # match a single attr & its value
|
.* # or anything else
''', re.VERBOSE)
EXTENSIONS = {'image/png': 'png',
'image/jpeg': 'jpg',
'image/bmp': 'bmp',
'image/gif': 'gif',
'image/tiff': 'tif',
'image/xbm': 'xbm',
}
AEROO_URI = 'http://alistek.com/'
GENSHI_URI = 'http://genshi.edgewall.org/'
MANIFEST = 'META-INF/manifest.xml'
META = 'meta.xml'
STYLES = 'styles.xml'
output_encode = genshi.output.encode
EtreeElement = lxml.etree.Element
TAB = "[%s]" % md5("&#x9;").hexdigest()
NEW_LINE = "[%s]" % md5("&#xA;").hexdigest()
# A note regarding OpenDocument namespaces:
#
# The current code assumes the original OpenOffice document uses default
# namespace prefix ("table", "xlink", "draw", ...). We derive the actual
# namespaces URIs from their prefix, instead of the other way round. This has
# the advantage that if a new version of the format use different namespaces
# (this is not the case for ODF 1.1 but could be the case in the future since
# there is a version number in those namespaces after all), Aeroo will
# support those new formats out of the box.
# A note about attribute namespaces:
#
# Ideally, we should update the namespace map of all the nodes we add
# (Genshi) attributes to, so that the attributes use a nice "py" prefix instead
# of a generated one (eg. "ns0", which is correct but ugly) in the case no
# parent node defines it. Unfortunately, lxml doesn't support this:
# the nsmap attribute of Element objects is (currently) readonly.
class OOTemplateError(genshi.template.base.TemplateSyntaxError):
"Error to raise when there is a SyntaxError in the genshi template"
class ImageHref:
"A class used to add images in the odf zipfile"
def __init__(self, namespaces, zfile, manifest, context):
self.namespaces = namespaces
self.zip = zfile
self.manifest = manifest
self.context = context.copy()
def __call__(self, expr):
bitstream, mimetype = expr[:2]
if isinstance(bitstream, Report):
bitstream = bitstream(**self.context).render()
bitstream.seek(0)
file_content = bitstream.read()
if len(file_content)>0:
name = md5(file_content).hexdigest()
path = 'Pictures/%s.%s' % (name, EXTENSIONS[mimetype])
if path not in self.zip.namelist():
self.zip.writestr(path, file_content)
self.manifest.add_file_entry(path, mimetype)
if len(expr) == 4:
width, height = expr[2:]
else:
width = height = False
attrs = {'{%s}href' % self.namespaces['xlink']: path}
if width:
attrs['{%s}width' % self.namespaces['svg']] = width
if height:
attrs['{%s}height' % self.namespaces['svg']] = height
return attrs
else:
return {}
class ColumnCounter:
"""A class used to count the actual maximum number of cells (and thus
columns) a table contains accross its rows.
"""
def __init__(self):
self.temp_counters = {}
self.counters = {}
def reset(self, loop_id):
self.temp_counters[loop_id] = 0
def inc(self, loop_id):
self.temp_counters[loop_id] += 1
def store(self, loop_id, table_name):
self.counters[table_name] = max(self.temp_counters.pop(loop_id),
self.counters.get(table_name, 0))
def wrap_nodes_between(first, last, new_parent):
"""An helper function to move all nodes between two nodes to a new node
and add that new node to their former parent. The boundary nodes are
removed in the process.
"""
old_parent = first.getparent()
# Any text after the opening tag (and not within a tag) need to be handled
# explicitly. For example in <if>xxx<span>yyy</span>zzz</if>, zzz is
# copied along the span tag, but not xxx, which corresponds to the tail
# attribute of the opening tag.
if first.tail:
new_parent.text = first.tail
for node in first.itersiblings():
if node is last:
break
# appending a node to a new parent also
# remove it from its previous parent
new_parent.append(node)
old_parent.replace(first, new_parent)
new_parent.tail = last.tail
old_parent.remove(last)
def update_py_attrs(node, value):
"""An helper function to update py_attrs of a node.
"""
if not value:
return
py_attrs_attr = '{%s}attrs' % GENSHI_URI
if not py_attrs_attr in node.attrib:
node.attrib[py_attrs_attr] = value
else:
node.attrib[py_attrs_attr] = \
"(lambda x, y: x.update(y) or x)(%s or {}, %s or {})" % \
(node.attrib[py_attrs_attr], value)
def _filter(val):
if type(val)==bool:
return ''
elif isinstance(val, (str, unicode)):
return val.replace('\t', TAB).replace('\r\n', NEW_LINE).replace('\n', NEW_LINE)
else:
return val
def _hyperlink(namespaces):
def _hyperlink(expr):
attrs = {'{%s}href' % namespaces['xlink']:expr}
return attrs
return _hyperlink
class Template(MarkupTemplate):
def __init__(self, source, serializer, filepath=None, styles=None, filename=None, loader=None,
encoding=None, lookup='strict', allow_exec=True):
self.namespaces = {}
self.inner_docs = []
self.has_col_loop = False
self.Serializer = serializer #OOSerializer(filepath or source, oo_styles=styles)
super(Template, self).__init__(source, filepath, filename, loader,
encoding, lookup, allow_exec)
def _parse(self, source, encoding):
"""parses the odf file.
It adds genshi directives and finds the inner docs.
"""
zf = self.Serializer.inzip
content = self.Serializer.content_xml
styles = self.Serializer.styles_xml
template = super(Template, self)
content = template._parse(self.insert_directives(content), encoding)
styles = template._parse(self.insert_directives(styles), encoding)
content_files = [('content.xml', content)]
styles_files = [('styles.xml', styles)]
while self.inner_docs:
doc = self.inner_docs.pop()
c_path, s_path = doc + '/content.xml', doc + '/styles.xml'
content = zf.read(c_path)
styles = zf.read(s_path)
c_parsed = template._parse(self.insert_directives(content),
encoding)
s_parsed = template._parse(self.insert_directives(styles),
encoding)
content_files.append((c_path, c_parsed))
styles_files.append((s_path, s_parsed))
parsed = []
for fpath, fparsed in content_files + styles_files:
parsed.append((genshi.core.PI, ('aeroo', fpath), None))
parsed += fparsed
return parsed
def insert_directives(self, content):
"""adds the genshi directives, handle the images and the innerdocs.
"""
tree = lxml.etree.parse(StringIO(content))
root = tree.getroot()
# assign default/fake namespaces so that documents do not need to
# define them if they don't use them
self.namespaces = {
"text": "urn:text",
"draw": "urn:draw",
"table": "urn:table",
"office": "urn:office",
"xlink": "urn:xlink",
"svg": "urn:svg",
}
# but override them with the real namespaces
self.namespaces.update(root.nsmap)
# remove any "root" namespace as lxml.xpath do not support them
self.namespaces.pop(None, None)
self.namespaces['py'] = GENSHI_URI
self.namespaces['aeroo'] = AEROO_URI
self._invert_style(tree)
self._handle_aeroo_tags(tree)
self._handle_images(tree)
self._handle_hyperlinks(tree)
self._handle_innerdocs(tree)
self._escape_values(tree)
return StringIO(lxml.etree.tostring(tree))
def _invert_style(self, tree):
"inverts the text:a and text:span"
xpath_expr = "//text:a[starts-with(@xlink:href, 'python://')]" \
"/text:span"
for span in tree.xpath(xpath_expr, namespaces=self.namespaces):
text_a = span.getparent()
outer = text_a.getparent()
text_a.text = span.text
span.text = ''
text_a.remove(span)
outer.replace(text_a, span)
span.append(text_a)
def _aeroo_statements(self, tree):
def check_except_directive( expr):
if GENSHI_EXPR.match(expr).groups()[1] is not None:
return False
return True
"finds the aeroo statements (text:a/text:placeholder)"
# If this node href matches the aeroo URL it is kept.
# If this node href matches a genshi directive it is kept for further
# processing.
xlink_href_attrib = '{%s}href' % self.namespaces['xlink']
text_a = '{%s}a' % self.namespaces['text']
placeholder = '{%s}placeholder' % self.namespaces['text']
text_input = '{%s}text-input' % self.namespaces['text']
s_xpath = "//text:a[starts-with(@xlink:href, 'python://')]" \
"| //text:placeholder" \
"| //text:text-input[starts-with(@text:description, '<') and substring(@text:description, string-length(@text:description))='>']"
r_statements = []
opened_tags = []
# We map each opening tag with its closing tag
closing_tags = {}
dir_sequence = [] # its need for follow syntax checking in template
for statement in tree.xpath(s_xpath, namespaces=self.namespaces):
if statement.tag == placeholder:
if not statement.text:
continue
expr = statement.text[1:-1]
expr = check_except_directive(expr) and "__filter(%s)" % statement.text[1:-1] or expr
elif statement.tag == text_input:
expr = statement.attrib["{%s}description" % self.namespaces['text']][1:-1]
if expr=='_()':
expr = "_('%s')" % statement.text
expr = check_except_directive(expr) and "__filter(%s)" % expr
else:
expr = check_except_directive(expr) and "__filter(%s)" % statement.attrib["{%s}description" % self.namespaces['text']][1:-1] or expr
elif statement.tag == text_a:
expr = urllib.unquote(statement.attrib[xlink_href_attrib][9:])
expr = check_except_directive(expr) and "__filter(%s)" % urllib.unquote(statement.attrib[xlink_href_attrib][9:]) or expr
if not expr:
raise OOTemplateError("No expression in the tag",
self.filepath)
closing, directive, attr, attr_val = \
GENSHI_EXPR.match(expr).groups()
is_opening = closing != '/'
if directive is not None:
dir_sequence.append((directive, expr, is_opening))
# map closing tags with their opening tag
if is_opening:
opened_tags.append(statement)
else:
if not opened_tags:
continue
closing_tags[id(opened_tags.pop())] = statement
# - we only need to return opening statements
if is_opening:
r_statements.append((statement,(expr, directive, attr, attr_val)))
##### Template syntax checking (has no opening/closing tags) #####
check_opening = {}
open_stm_by_type = {}
while(dir_sequence):
directive = dir_sequence.pop()
check_opening.setdefault(directive[0], 0)
if directive[2]: # only for opening tags
if directive[0] not in open_stm_by_type:
open_stm_by_type.setdefault(directive[0], [directive[1]])
else:
open_stm_by_type[directive[0]].append(directive[1])
check_opening[directive[0]] += directive[2] and -1 or 1
for stm in check_opening:
if check_opening[stm]<0: # has no closing tag
error_stm = open_stm_by_type[stm][check_opening[stm]-1]
raise Exception("Statement has no closing tag. <%s>" % error_stm)
if check_opening[stm]>0: # has no opening tag
error_stm = "/%s" % stm
raise Exception("Statement has no opening tag. <%s>" % error_stm)
##################################################################
return r_statements, closing_tags
def _handle_aeroo_tags(self, tree):
"""
Will treat all aeroo tag (py:if/for/choose/when/otherwise)
tags
"""
# Some tag/attribute name constants
table_namespace = self.namespaces['table']
table_row_tag = '{%s}table-row' % table_namespace
table_cell_tag = '{%s}table-cell' % table_namespace
office_name = '{%s}value' % self.namespaces['office']
office_valuetype = '{%s}value-type' % self.namespaces['office']
py_attrs_attr = '{%s}attrs' % GENSHI_URI
py_replace = '{%s}replace' % GENSHI_URI
r_statements, closing_tags = self._aeroo_statements(tree)
for r_node, parsed in r_statements:
expr, directive, attr, a_val = parsed
# If the node is a genshi directive statement:
if directive is not None:
opening = r_node
closing = closing_tags[id(r_node)]
# - we find the nearest common ancestor of the closing and
# opening statements
o_ancestors = [opening]
c_ancestors = [closing] + list(closing.iterancestors())
ancestor = None
for node in opening.iterancestors():
try:
idx = c_ancestors.index(node)
assert c_ancestors[idx] == node
# we only need ancestors up to the common one
del c_ancestors[idx:]
ancestor = node
break
except ValueError:
# c_ancestors.index(node) raise ValueError if node is
# not a child of c_ancestors
pass
o_ancestors.append(node)
assert ancestor is not None, \
"No common ancestor found for opening and closing tag"
outermost_o_ancestor = o_ancestors[-1]
outermost_c_ancestor = c_ancestors[-1]
# handle horizontal repetitions (over columns)
if directive == "for" and ancestor.tag == table_row_tag:
a_val = self._handle_column_loops(parsed, ancestor,
opening,
outermost_o_ancestor,
outermost_c_ancestor)
# - we create a <py:xxx> node
if attr is not None:
attribs = {attr: a_val}
else:
attribs = {}
genshi_node = EtreeElement('{%s}%s' % (GENSHI_URI,
directive),
attrib=attribs,
nsmap={'py': GENSHI_URI})
# - we move all the nodes between the opening and closing
# statements to this new node (append also removes from old
# parent)
# - we replace the opening statement by the <py:xxx> node
# - we delete the closing statement (and its ancestors)
######## This is need for removing only closing genshi tag except other children tags of <p> tag ########
if len(outermost_c_ancestor)>1 and closing in outermost_c_ancestor.getchildren():
outermost_c_ancestor_copy = deepcopy(outermost_c_ancestor)
outermost_c_ancestor.remove(closing)
outermost_c_ancestor.getparent().append(outermost_c_ancestor_copy)
outermost_c_ancestor = outermost_c_ancestor_copy
#########################################################################################################
wrap_nodes_between(outermost_o_ancestor, outermost_c_ancestor, genshi_node)
else:
# It's not a genshi statement it's a python expression
r_node.attrib[py_replace] = expr
parent = r_node.getparent().getparent()
if parent is None or parent.tag != table_cell_tag:
continue
update_py_attrs(parent, "{'guess_type':1}")
def _handle_column_loops(self, statement, ancestor, opening,
outer_o_node, outer_c_node):
_, directive, attr, a_val = statement
self.has_col_loop = True
table_namespace = self.namespaces['table']
table_col_tag = '{%s}table-column' % table_namespace
table_num_col_attr = '{%s}number-columns-repeated' % table_namespace
py_attrs_attr = '{%s}attrs' % GENSHI_URI
repeat_tag = '{%s}repeat' % AEROO_URI
# table node (it is not necessarily the direct parent of ancestor)
table_node = ancestor.iterancestors('{%s}table' % table_namespace) \
.next()
table_name = table_node.attrib['{%s}name' % table_namespace]
# add counting instructions
loop_id = id(opening)
# 1) add reset counter code on the row opening tag
# (through a py:attrs attribute).
# Note that table_name is not needed in the first two
# operations, but a unique id within the table is required
# to support nested column repetition
update_py_attrs(ancestor, "__aeroo_reset_col_count(%d)" % loop_id)
# 2) add increment code (through a py:attrs attribute) on
# the first cell node after the opening (cell node)
# ancestor
enclosed_cell = outer_o_node.getnext()
assert enclosed_cell.tag == '{%s}table-cell' % table_namespace
update_py_attrs(enclosed_cell, "__aeroo_inc_col_count(%d)" %
loop_id)
# 3) add "store count" code as a py:replace node, as the
# last child of the row
attr_value = "__aeroo_store_col_count(%d, %r)" \
% (loop_id, table_name)
replace_node = EtreeElement('{%s}replace' % GENSHI_URI,
attrib={'value': attr_value},
nsmap={'py': GENSHI_URI})
ancestor.append(replace_node)
# find the position in the row of the cells holding the
# <for> and </for> instructions
# We use "*" so as to count both normal cells and covered/hidden cells
position_xpath_expr = 'count(preceding-sibling::*)'
opening_pos = \
int(outer_o_node.xpath(position_xpath_expr,
namespaces=self.namespaces))
closing_pos = \
int(outer_c_node.xpath(position_xpath_expr,
namespaces=self.namespaces))
# check whether or not the opening tag spans several rows
a_val = self._handle_row_spanned_column_loops(
statement, outer_o_node, opening_pos, closing_pos)
# check if this table's headers were already processed
repeat_node = table_node.find(repeat_tag)
if repeat_node is not None:
prev_pos = (int(repeat_node.attrib['opening']),
int(repeat_node.attrib['closing']))
if (opening_pos, closing_pos) != prev_pos:
raise Exception(
'Incoherent column repetition found! '
'If a table has several lines with repeated '
'columns, the repetition need to be on the '
'same columns across all lines.')
else:
# compute splits: oo collapses the headers of adjacent
# columns which use the same style. We need to split
# any column header which is repeated so many times
# that it encompasses any of the column headers that
# we need to repeat
to_split = []
idx = 0
childs = list(table_node.iterchildren(table_col_tag))
for tag in childs:
inc = int(tag.attrib.get(table_num_col_attr, 1))
oldidx = idx
idx += inc
if oldidx < opening_pos < idx or \
oldidx < closing_pos < idx:
to_split.append(tag)
# split tags
for tag in to_split:
tag_pos = table_node.index(tag)
num = int(tag.attrib.pop(table_num_col_attr))
new_tags = [deepcopy(tag) for _ in range(num)]
table_node[tag_pos:tag_pos+1] = new_tags
# recompute the list of column headers as it could
# have changed.
coldefs = list(table_node.iterchildren(table_col_tag))
# compute the column header nodes corresponding to
# the opening and closing tags.
first = table_node[opening_pos]
last = table_node[closing_pos]
# add a <aeroo:repeat> node around the column
# definitions nodes
attribs = {
"opening": str(opening_pos),
"closing": str(closing_pos),
"table": table_name
}
repeat_node = EtreeElement(repeat_tag, attrib=attribs,
nsmap={'aeroo': AEROO_URI})
wrap_nodes_between(first, last, repeat_node)
return a_val
def _handle_row_spanned_column_loops(self, statement, outer_o_node,
opening_pos, closing_pos):
"""handles column repetitions which span several rows, by duplicating
the py:for node for each row, and make the loops work on a copy of the
original iterable as to not exhaust generators."""
_, directive, attr, a_val = statement
table_namespace = self.namespaces['table']
table_rowspan_attr = '{%s}number-rows-spanned' % table_namespace
# checks wether there is a (meaningful) rowspan
rows_spanned = int(outer_o_node.attrib.get(table_rowspan_attr, 1))
if rows_spanned == 1:
return a_val
table_row_tag = '{%s}table-row' % table_namespace
table_cov_cell_tag = '{%s}covered-table-cell' % table_namespace
# if so, we need to:
# 1) create a with node to define a temporary variable
temp_var = "__aeroo_temp%d" % id(outer_o_node)
# a_val == "target in iterable"
target, iterable = a_val.split(' in ', 1)
vars = "%s = list(%s)" % (temp_var, iterable.strip())
with_node = EtreeElement('{%s}with' % GENSHI_URI,
attrib={"vars": vars},
nsmap={'py': GENSHI_URI})
# 2) transform a_val to use that temporary variable
a_val = "%s in %s" % (target, temp_var)
# 3) wrap the corresponding cells on the next row(s)
# (those should be covered-table-cell) inside a
# duplicate py:for node (looping on the temporary
# variable).
row_node = outer_o_node.getparent()
row_node.addprevious(with_node)
rows_to_wrap = [row_node]
assert row_node.tag == table_row_tag
next_rows = row_node.itersiblings(table_row_tag)
for row_idx in range(rows_spanned-1):
next_row_node = next_rows.next()
rows_to_wrap.append(next_row_node)
# compute the start and end nodes
first = next_row_node[opening_pos]
last = next_row_node[closing_pos]
assert first.tag == table_cov_cell_tag
assert last.tag == table_cov_cell_tag
# wrap them
tag = '{%s}%s' % (GENSHI_URI, directive)
for_node = EtreeElement(tag,
attrib={attr: a_val},
nsmap={'py': GENSHI_URI})
wrap_nodes_between(first, last, for_node)
# 4) wrap all the corresponding rows indide the "with"
# node
for node in rows_to_wrap:
with_node.append(node)
return a_val
def _handle_images(self, tree):
"replaces all draw:frame named 'image: ...' by draw:image nodes"
draw_namespace = self.namespaces['draw']
draw_name = '{%s}name' % draw_namespace
draw_image = '{%s}image' % draw_namespace
py_attrs = '{%s}attrs' % self.namespaces['py']
svg_namespace = self.namespaces['svg']
svg_width = '{%s}width' % svg_namespace
svg_height = '{%s}height' % svg_namespace
xpath_expr = "//draw:frame[starts-with(@draw:name, 'image:')]"
for draw in tree.xpath(xpath_expr, namespaces=self.namespaces):
d_name = draw.attrib[draw_name][6:].strip()
draw.attrib[draw_name] = "Aeroo picture "
attr_expr = "__aeroo_make_href(%s)" % d_name
image_node = EtreeElement(draw_image,
attrib={py_attrs: attr_expr},
nsmap={'draw': draw_namespace,
'py': GENSHI_URI})
draw.replace(draw[0], image_node)
def _handle_hyperlinks(self, tree):
xpath_href_expr = "//draw:a[starts-with(@xlink:href, 'python://')] | //text:a[starts-with(@xlink:href, 'pythonuri://')]"
href_attrib = '{%s}href' % self.namespaces['xlink']
py_attrs = '{%s}attrs' % self.namespaces['py']
for a in tree.xpath(xpath_href_expr, namespaces=self.namespaces):
a.attrib[py_attrs] = "__aeroo_hyperlink(%s)" % urllib.unquote(a.attrib[href_attrib]).replace('python://','').replace('pythonuri://','')#[9:]
del a.attrib[href_attrib]
def _handle_innerdocs(self, tree):
"finds inner_docs and adds them to the processing stack."
href_attrib = '{%s}href' % self.namespaces['xlink']
xpath_expr = "//draw:object[starts-with(@xlink:href, './')" \
"and @xlink:show='embed']"
for draw in tree.xpath(xpath_expr, namespaces=self.namespaces):
self.inner_docs.append(draw.attrib[href_attrib][2:])
def _escape_values(self, tree):
"escapes element values"
for element in tree.iter():
for attrs in element.keys():
if not attrs.startswith('{%s}' % GENSHI_URI):
element.attrib[attrs] = element.attrib[attrs]\
.replace(PREFIX, PREFIX * 2)
if element.text:
element.text = element.text.replace(PREFIX, PREFIX * 2)
def generate(self, *args, **kwargs):
"creates the AerooStream."
#serializer = OOSerializer(self.filepath)
self.Serializer.new_oo = StringIO()
outzip = zipfile.ZipFile(self.Serializer.new_oo, 'w')
self.Serializer.outzip = outzip
kwargs['__aeroo_make_href'] = ImageHref(self.namespaces, outzip, self.Serializer.manifest, kwargs)
kwargs['__aeroo_hyperlink'] = _hyperlink(self.namespaces)
if '__filter' not in kwargs:
kwargs['__filter'] = _filter
counter = ColumnCounter()
kwargs['__aeroo_reset_col_count'] = counter.reset
kwargs['__aeroo_inc_col_count'] = counter.inc
kwargs['__aeroo_store_col_count'] = counter.store
stream = super(Template, self).generate(*args, **kwargs)
if self.has_col_loop:
# Note that we can't simply add a "number-columns-repeated"
# attribute and then fill it with the correct number of columns
# because that wouldn't work if more than one column is repeated.
transformation = DuplicateColumnHeaders(counter)
col_filter = Transformer('//repeat[namespace-uri()="%s"]'
% AEROO_URI)
col_filter = col_filter.apply(transformation)
stream = Stream(list(stream), self.serializer) | col_filter
return AerooStream(stream, self.Serializer)
class DuplicateColumnHeaders(object):
def __init__(self, counter):
self.counter = counter
def __call__(self, stream):
for mark, (kind, data, pos) in stream:
# for each repeat tag found
if mark is ENTER:
# get the number of columns for that table
attrs = data[1]
table = attrs.get('table')
col_count = self.counter.counters[table]
# collect events (column header tags) to repeat
events = []
for submark, event in stream:
if submark is EXIT:
break
events.append(event)
# repeat them
for _ in range(col_count):
for event in events:
yield None, event
else:
yield mark, (kind, data, pos)
class Manifest(object):
def __init__(self, content):
self.tree = lxml.etree.parse(StringIO(content))
self.root = self.tree.getroot()
self.namespaces = self.root.nsmap
for el in filter(lambda child: child.tag=="{%s}file-entry" % self.namespaces['manifest'], self.root.iterchildren()):
if filter(lambda a: a[0]=='{%s}full-path' % self.namespaces['manifest'] and a[1].startswith("Thumbnails"), el.items()):
self.root.remove(el)
def __str__(self):
return lxml.etree.tostring(self.tree, encoding='UTF-8',
xml_declaration=True)
def add_file_entry(self, path, mimetype=None):
manifest_namespace = self.namespaces['manifest']
attribs = {'{%s}media-type' % manifest_namespace: mimetype or '',
'{%s}full-path' % manifest_namespace: path}
entry_node = EtreeElement('{%s}%s' % (manifest_namespace,
'file-entry'),
attrib=attribs,
nsmap={'manifest': manifest_namespace})
self.root.append(entry_node)
class Meta(object):
def __init__(self, content):
self.tree = lxml.etree.parse(StringIO(content))
self.root = self.tree.getroot()
self.namespaces = self.root.nsmap
self.meta_root = self.root.getchildren()[0]
self.add_entry('editing-cycles', 'meta', '1')
self.add_entry('editing-duration', 'meta', '')
def __str__(self):
return lxml.etree.tostring(self.tree, encoding='UTF-8',
xml_declaration=True)
def add_entry(self, tag_name, namespace, data=None, attribs={}):
meta_namespace = self.namespaces['meta']
entry_node = self.meta_root.find('{%s}%s' % (self.namespaces[namespace],tag_name))
if entry_node is None:
entry_node = EtreeElement('{%s}%s' % (self.namespaces[namespace],tag_name),
nsmap={'meta': meta_namespace},
attrib=attribs)
self.meta_root.append(entry_node)
else:
entry_node.attrib.update(attribs)
entry_node.text = data
def add_property(self, data=None, ptype=''):
meta_namespace = self.namespaces['meta']
entry_node = EtreeElement('{%s}%s' % (self.namespaces['meta'],'user-defined'),
nsmap={'meta': meta_namespace},
attrib={'{%s}name' % self.namespaces['meta']:ptype})
self.meta_root.append(entry_node)
entry_node.text = data
class TStyle(object):
def __init__(self, content):
self.tree = lxml.etree.parse(StringIO(content))
self.root = self.tree.getroot()
self.namespaces = self.root.nsmap
def __str__(self):
return lxml.etree.tostring(self.tree, encoding='UTF-8',
xml_declaration=True)
class TContent(object):
def __init__(self, content):
self.tree = lxml.etree.parse(StringIO(content))
self.root = self.tree.getroot()
self.namespaces = self.root.nsmap
ns = lxml.etree.FunctionNamespace(None)
def __str__(self):
return lxml.etree.tostring(self.tree, encoding='UTF-8',
xml_declaration=True)
class OOSerializer:
def __init__(self, oo_template, oo_styles=None):
self.template = oo_template
self.inzip = zipfile.ZipFile(self.template)
self.manifest = Manifest(self.inzip.read(MANIFEST))
self.meta = Meta(self.inzip.read(META))
self.content_xml = self.inzip.read('content.xml')
self.styles_xml = self.inzip.read('styles.xml')
self.apply_style(oo_styles)
self.new_oo = None
self.xml_serializer = genshi.output.XMLSerializer()
def check_tabs(self, tree, namespaces):
tags = tree.xpath("//text:*/text()[contains(string(), '%s')]/.." % TAB, namespaces=namespaces)
for tag in tags:
children = tag.getchildren()
if tag.text:
tabs_text=tag.text.split(TAB)
tag.text=tabs_text.pop(0)
pos = 0
for text in tabs_text:
new_node = EtreeElement('{%s}tab' % namespaces['text'],
attrib={},
nsmap=namespaces)
new_node.tail=text
tag.insert(pos,new_node)
pos += 1
else:
new_node = EtreeElement('{%s}tab' % namespaces['text'],
attrib=tag.attrib,
nsmap=namespaces)
tag.addnext(new_node)
for child in tag.iterchildren():
if not child.tail:
continue
child_tail = child.tail
child.tail = ''
tail_text = child_tail.split(TAB)
n = len(tail_text)-1
while n:
new_node = EtreeElement('{%s}tab' % namespaces['text'],
attrib={},
nsmap=namespaces)
child.addnext(new_node)
n -= 1
child.tail = tail_text.pop(0)
last_node = child.getnext()
for text in tail_text:
last_node.tail = text
last_node = last_node.getnext()
def check_spaces(self, tree, namespaces):
tags = tree.xpath("//text:*[starts-with(text(), ' ') or substring(name(),string-length(name())-1)=' ']", namespaces=namespaces)
for tag in tags:
children = tag.getchildren()
if tag.text:
tabs_text=tag.text.split(' ')
tag.text=tabs_text.pop(0)
pos = 0
for text in tabs_text:
new_node = EtreeElement('{%s}s' % namespaces['text'],
attrib={},
nsmap=namespaces)
new_node.tail=text
tag.insert(pos,new_node)
pos += 1
else:
new_node = EtreeElement('{%s}s' % namespaces['text'],
attrib=tag.attrib,
nsmap=namespaces)
tag.addnext(new_node)
for child in tag.iterchildren():
if not child.tail:
continue
child_tail = child.tail
child.tail = ''
tail_text = child_tail.split(' ')
n = len(tail_text)-1
while n:
new_node = EtreeElement('{%s}s' % namespaces['text'],
attrib={},
nsmap=namespaces)
child.addnext(new_node)
n -= 1
child.tail = tail_text.pop(0)
last_node = child.getnext()
for text in tail_text:
last_node.tail = text
last_node = last_node.getnext()
def check_new_lines(self, tree, namespaces):
#tags = tree.xpath("//text:*[contains(text(), '%s')]" % NEW_LINE, namespaces=namespaces)
#tags = tree.xpath("//text:*[text()[contains(., '%s')]]" % NEW_LINE, namespaces=namespaces)
span_tags = tree.xpath("//text:span[text()[contains(., '%s')]]" % NEW_LINE, namespaces=namespaces)
tags = tree.xpath("//text:*[text()[contains(., '%s')]]" % NEW_LINE, namespaces=namespaces)
tags = list(set(tags)-set(span_tags))
#tags = tree.xpath("//text:*[text()[contains(., '%s')]]" % NEW_LINE, namespaces=namespaces)
for tag in tags:
children = tag.getchildren()
if tag.text:
for text in tag.text.split(NEW_LINE):
new_node = EtreeElement('%s' % tag.tag,
attrib=tag.attrib,
nsmap=namespaces)
new_node.text=text
tag.addprevious(new_node)
last_node=new_node
else:
new_node = EtreeElement('%s' % tag.tag,
attrib=tag.attrib,
nsmap=namespaces)
last_node = new_node
tag.addnext(new_node)
if children:
for child in children:
if tag.text and tag.text.endswith(NEW_LINE):
new_node = EtreeElement('%s' % tag.tag,
attrib=tag.attrib,
nsmap=namespaces)
new_node.append(child)
last_node.addnext(new_node)
last_node = new_node
last_child = None
else:
last_node.append(child)
last_child = child
if not child.tail:
continue
child_tail = child.tail
child.tail = ''
tail_text = child_tail.split(NEW_LINE)
if tail_text[0] is not None and last_child is not None:
last_child.tail = tail_text.pop(0)
for text in tail_text:
new_node = EtreeElement('%s' % tag.tag,
attrib=tag.attrib,
nsmap=namespaces)
new_node.text=text
last_node.addnext(new_node)
last_node = new_node
if tag.text:
tag.getparent().remove(tag)
for tag in span_tags:
if tag.tag=='{%s}span' % namespaces['text']:
span_texts = tag.text.split(NEW_LINE)
parent = tag.getparent()
parent_attrib = parent.attrib
parent_children = parent.iterchildren()
parent_itertext = parent.itertext()
parent_text = parent.text
parent_tail = parent.tail
new_parent_node = EtreeElement('%s' % parent.tag,
attrib=parent_attrib,
nsmap=namespaces)
parent.getparent().replace(parent, new_parent_node)
new_parent_node.text = parent_text
new_parent_node.tail = parent_tail
next_child = new_parent_node
try:
while(True):
curr_child = parent_children.next()
if curr_child.tag=='{%s}span' % namespaces['text'] and tag.text==curr_child.text:
new_span_node = EtreeElement('{%s}span' % namespaces['text'],
attrib=tag.attrib,
nsmap=namespaces)
new_span_node.text = span_texts.pop(0)
next_child.append(new_span_node)
curr_child = next_child
for text in span_texts:
new_node = EtreeElement('%s' % parent.tag,
attrib=parent_attrib,
nsmap=namespaces)
new_span_node = EtreeElement('{%s}span' % namespaces['text'],
attrib=tag.attrib,
nsmap=namespaces)
new_span_node.text=text
new_node.append(new_span_node)
curr_child.addnext(new_node)
curr_child = new_node
new_span_node.tail = tag.tail # set tail of source node in tail of latest new node
break
else:
next_child.append(curr_child)
except StopIteration:
pass
try:
next_text = True
while(next_text):
next_child = parent_children.next()
curr_child.append(next_child)
next_text = next_child.text
except StopIteration:
pass
try:
while(True):
next_child = parent_children.next()
if not next_child.text:
curr_child.append(next_child)
else:
new_node = EtreeElement('%s' % parent.tag,
attrib=parent_attrib,
nsmap=namespaces)
new_node.append(next_child)
curr_child.addnext(new_node)
curr_child = new_node
if next_child.tail:
next_child_texts = next_child.tail.split(NEW_LINE)
next_child.tail = next_child_texts.pop(0)
for next_text in next_child_texts:
new_node = EtreeElement('%s' % parent.tag,
attrib=parent_attrib,
nsmap=namespaces)
new_node.text=next_text
curr_child.addnext(new_node)
curr_child = new_node
except StopIteration:
pass
def check_guess_type(self, tree, namespaces):
tags = tree.xpath('//table:table-cell[@guess_type]', namespaces=namespaces)
for tag in tags:
if len(tag)==0 or len(tag)>1 or tag[0].getchildren():
guess_type = 'string'
else:
try:
float(tag[0].text)
guess_type = 'float'
tag.attrib['{%s}value' % namespaces['office']] = tag[0].text
except (ValueError,TypeError):
guess_type = 'string'
tag.attrib['{%s}value-type' % namespaces['office']] = guess_type
del tag.attrib['guess_type']
def check_images(self, tree, namespaces):
tags = tree.xpath('//draw:frame/draw:image[@svg:height and @svg:width]', namespaces=namespaces)
for tag in tags:
height = tag.attrib['{%s}height' % namespaces['svg']]
width = tag.attrib['{%s}width' % namespaces['svg']]
del tag.attrib['{%s}height' % namespaces['svg']]
del tag.attrib['{%s}width' % namespaces['svg']]
tag.getparent().attrib.update({'{%s}height' % namespaces['svg']:height,
'{%s}width' % namespaces['svg']:width})
def apply_style(self, oo_styles):
if oo_styles:
self.styles_zip = zipfile.ZipFile(oo_styles)
self.styles_new = TStyle(self.styles_zip.read(STYLES))
self.styles_new_xml = str(self.styles_new)
self.styles = TStyle(self.inzip.read(STYLES))
##### font-face #####
font_face_new = self.styles_new.root.xpath('//office:font-face-decls/style:font-face', \
namespaces=self.styles_new.namespaces)
font_face_orig = self.styles.root.xpath('//office:font-face-decls/style:font-face', \
namespaces=self.styles.namespaces)
self._replace_style_by_attrib(font_face_new, font_face_orig, 'name', self.styles.namespaces['style'])
###### styles ######
new_styles = self.styles_new.root.xpath('//office:styles/style:style', \
namespaces=self.styles_new.namespaces)
orig_styles = self.styles.root.xpath('//office:styles/style:style', \
namespaces=self.styles.namespaces)
self._replace_style_by_attrib(new_styles, orig_styles, 'name', self.styles.namespaces['style'])
##### master-styles #####
new_master_page_styles = self.styles_new.root.xpath('//office:master-styles/style:master-page', namespaces=self.styles_new.namespaces)#[0]
orig_master_page_styles = self.styles.root.xpath('//office:master-styles/style:master-page', namespaces=self.styles.namespaces)#[0]
self._replace_style_by_attrib(new_master_page_styles, orig_master_page_styles, 'name', self.styles.namespaces['style'])
##### automatic-styles #####
new_automatic_page_styles = self.styles_new.root.xpath('//office:automatic-styles/style:style', namespaces=self.styles_new.namespaces)#[0]
orig_automatic_page_styles = self.styles.root.xpath('//office:automatic-styles/style:style', namespaces=self.styles.namespaces)#[0]
if orig_automatic_page_styles:
self._replace_style_by_attrib(new_automatic_page_styles, orig_automatic_page_styles, 'name', self.styles.namespaces['style'])
else:
dest_node = self.styles.root.xpath('//office:automatic-styles', namespaces=self.styles_new.namespaces)[0]
self._add_styles(new_automatic_page_styles, dest_node)
new_page_layout = self.styles_new.root.xpath('//office:automatic-styles/style:page-layout', \
namespaces=self.styles_new.namespaces)
orig_page_layout = self.styles.root.xpath('//office:automatic-styles/style:page-layout', \
namespaces=self.styles.namespaces)
self._replace_style_by_attrib(new_page_layout, orig_page_layout, 'name', self.styles.namespaces['style'])
###########################
self.styles_xml = str(self.styles)
def add_title(self, title):
self.meta.add_entry('title', 'dc', title)
def add_creation_date(self, date):
self.meta.add_entry('date', 'dc', date)
self.meta.add_entry('creation-date', 'meta', date)
def add_creation_user(self, user):
self.meta.add_entry('creator', 'dc', user)
def add_generator_info(self, data):
self.meta.add_entry('generator', 'meta', data)
def add_custom_property(self, data, ptype):
self.meta.add_property(data, ptype)
def _add_styles(self, node_list, dest_node):
for node in node_list:
dest_node.append(deepcopy(node))
return dest_node
def _replace_style_by_attrib(self, node_list1, node_list2, name, namespace):
for node1 in node_list1:
#curr_node = filter(lambda node: node.get('{%s}%s' % (namespace,name))==node1.get('{%s}%s' % (namespace,name)), node_list2)
curr_node = None
node_to_update = []
for node2 in node_list2:
if node2.get('{%s}%s' % (namespace,name))==node1.get('{%s}%s' % (namespace,name)):
curr_node = node2
node_to_update.append(node2)
break
if curr_node is not None and curr_node.getchildren():
#curr_node=curr_node[0]
for child_node in curr_node.iterchildren():
curr_node.attrib.update(dict(node1.attrib))
orig_node = node1.find(child_node.tag)
if orig_node is not None:
new_attribs = dict(child_node.attrib)
new_attribs.update(orig_node.attrib)
new_child_node = EtreeElement(child_node.tag, attrib=new_attribs)
new_child_node.append(deepcopy(child_node))
orig_subchildren = orig_node.getchildren()
if orig_subchildren:
self._add_styles(orig_subchildren, new_child_node)
curr_node.replace(child_node, new_child_node)
node1.remove(orig_node)
if node1 is not None:
self._add_styles(node1, curr_node)
else:
node_list2[0].getparent().append(deepcopy(node1))
return node_list2
def __call__(self, stream):
files = {}
for kind, data, pos in stream:
if kind == genshi.core.PI and data[0] == 'aeroo':
stream_for = data[1]
continue
files.setdefault(stream_for, []).append((kind, data, pos))
now = time.localtime()[:6]
outzip = self.outzip
self.template.seek(0)
inzip = zipfile.ZipFile(StringIO(self.template.read()))
for f_info in inzip.infolist():
if f_info.filename.startswith('ObjectReplacements'):
continue
elif f_info.filename in files:
stream = files[f_info.filename]
# create a new file descriptor, copying some attributes from
# the original file
new_info = zipfile.ZipInfo(f_info.filename, now)
for attr in ('compress_type', 'flag_bits', 'create_system'):
setattr(new_info, attr, getattr(f_info, attr))
serialized_stream = output_encode(self.xml_serializer(stream), encoding='utf-8')
############### Styles usage #################
if f_info.filename == STYLES:
self.styles_orig = TStyle(serialized_stream)
self.check_guess_type(self.styles_orig.tree, self.styles_orig.namespaces)
self.check_images(self.styles_orig.tree, self.styles_orig.namespaces)
self.check_new_lines(self.styles_orig.tree, self.styles_orig.namespaces)
self.check_tabs(self.styles_orig.tree, self.styles_orig.namespaces)
self.check_spaces(self.styles_orig.tree, self.styles_orig.namespaces)
if hasattr(self, 'styles_new'):
pictures = []
for file_name in self.styles_zip.namelist():
if file_name.startswith('Pictures'):
picture = self.styles_zip.read(file_name)
pictures.append((file_name, picture))
self.manifest.add_file_entry(file_name)
for ffile, picture in pictures:
outzip.writestr(ffile, picture)
outzip.writestr(new_info, str(self.styles_orig))
###############################################
elif f_info.filename == 'content.xml':
content = TContent(serialized_stream)
self.check_guess_type(content.tree, content.namespaces)
self.check_images(content.tree, content.namespaces)
self.check_new_lines(content.tree, content.namespaces)
self.check_tabs(content.tree, content.namespaces)
self.check_spaces(content.tree, content.namespaces)
outzip.writestr(new_info, str(content))
else:
outzip.writestr(new_info, serialized_stream)
elif f_info.filename == MANIFEST:
outzip.writestr(f_info, str(self.manifest))
elif f_info.filename == META:
outzip.writestr(f_info, str(self.meta))
elif f_info.filename=='Thumbnails/thumbnail.png':
continue
else:
outzip.writestr(f_info, inzip.read(f_info.filename))
inzip.close()
outzip.close()
return self.new_oo is not None and self.new_oo or StringIO()
MIMETemplateLoader.add_factory('oo.org', Template)
build/lib.linux-x86_64-2.7/aeroolib/reporting.py 0 → 100644
##############################################################################
#
# Copyright (c) 2010 Alistek Ltd. (http://www.alistek.com) All Rights
# Reserved.
# General contacts <info@alistek.com>
#
# DISCLAIMER: This module is licensed under GPLv3 or newer and
# is considered incompatible with OpenERP SA "AGPL + Private Use License"!
#
# Copyright (c) 2007, 2008 OpenHex SPRL. (http://openhex.com) All Rights
# Reserved.
#
# WARNING: This program as such is intended to be used by professional
# programmers who take the whole responsability of assessing all potential
# consequences resulting from its eventual inadequacies and bugs
# End users who are looking for a ready-to-use solution with commercial
# garantees and support are strongly adviced to contract a Free Software
# Service Company
#
# This program is Free Software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 3
# of the License, or (at your option) any later version.
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
#
##############################################################################
__metaclass__ = type
import os, sys
import pkg_resources
from genshi.template import TemplateLoader
def _absolute(path):
"Compute the absolute path of path relative to the caller file"
if os.path.isabs(path):
return path
caller_fname = sys._getframe(2).f_globals['__file__']
caller_dir = os.path.dirname(caller_fname)
return os.path.abspath(os.path.join(caller_dir, path))
def _guess_type(mime):
"""
Returns the codename used by aeroolib to identify which template plugin
it should use to render a mimetype
"""
mime = mime.lower()
major, stype = mime.split('/', 1)
if major == 'application':
if 'opendocument' in stype:
return 'oo.org'
else:
return stype
elif major == 'text':
if stype in ('xml', 'html', 'xhtml'):
return 'markup'
else:
return 'text'
class MIMETemplateLoader(TemplateLoader):
"""This subclass of TemplateLoader use mimetypes to search and find
templates to load.
"""
factories = {}
mime_func = [_guess_type]
def get_type(self, mime):
"finds the codename used by aeroolib to work on a mimetype"
for func in reversed(self.mime_func):
codename = func(mime)
if codename is not None:
return codename
def load(self, path, mime=None, relative_to=None, cls=None):
"returns a template object based on path"
assert mime is not None or cls is not None
if mime is not None:
cls = self.factories[self.get_type(mime)]
return super(MIMETemplateLoader, self).load(
path, cls=cls, relative_to=relative_to)
@classmethod
def add_factory(cls, abbr_mimetype, template_factory, id_function=None):
"""adds a template factory to the already known factories"""
cls.factories[abbr_mimetype] = template_factory
if id_function is not None:
cls.mime_func.append(id_function)
default_loader = MIMETemplateLoader(auto_reload=True)
class DefaultFactory:
"""This is the default factory used by aeroolib.
It just returns a copy of the data it receives"""
def __init__(self, *args, **kwargs):
pass
def __call__(self, **kwargs):
data = kwargs.copy()
return data
default_factory = DefaultFactory()
class Report:
"""Report is a simple interface on top of a rendering template.
"""
def __init__(self, path, mimetype,
factory=default_factory, loader=default_loader):
self.fpath = path
self.mimetype = mimetype
self.data_factory = factory
self.tmpl_loader = loader
self.filters = []
def __call__(self, **kwargs):
template = self.tmpl_loader.load(self.fpath, self.mimetype)
data = self.data_factory(**kwargs)
return template.generate(**data).filter(*self.filters)
def __repr__(self):
return '<aeroo report on %s>' % self.fpath
class ReportDict:
def __init__(self, *args, **kwargs):
self.mimetypes = {}
self.ids = {}
class ReportRepository:
"""ReportRepository stores the report definition associated to objects.
The report are indexed in this object by the object class they are working
on and the name given to it by the user.
"""
def __init__(self, datafactory=DefaultFactory):
self.classes = {}
self.default_factory = datafactory
self.loader = default_loader
def add_report(self, klass, mimetype, template_path, data_factory=None,
report_name='default', description=''):
"""adds a report to the repository.
You will be able to find the report via
- the class it is working on
- the mimetype it outputs
- the name of the report
You also have the opportunity to define a specific data_factory.
"""
if data_factory is None:
data_factory = self.default_factory
reports = self.classes.setdefault(klass, ReportDict())
report = Report(_absolute(template_path), mimetype,
data_factory(klass, mimetype), self.loader)
reports.ids[report_name] = report, mimetype, description
reports.mimetypes.setdefault(mimetype, []) \
.append((report, report_name))
def by_mime(self, klass, mimetype):
"""gets a list of report related to a class by specifying the mimetype
"""
return self.classes[klass].mimetypes[mimetype]
def by_id(self, klass, id):
"""get a report related to a class by its id
"""
return self.classes[klass].ids[id]
setup.cfg 0 → 100755
[egg_info]
setup.py 0 → 100755
import os
import re
from setuptools import setup, find_packages
def get_version():
init = open(os.path.join(os.path.dirname(__file__), 'aeroolib',
'__init__.py')).read()
return re.search(r"""__version__ = '([0-9.\sA-Za-z]*)'""", init).group(1)
setup(
name="aeroolib",
url="http://www.alistek.com/",
author="Alistek Ltd",
author_email="info@alistek.com",
maintainer=u"Alistek Ltd",
maintainer_email="info@alistek.com",
description="A templating library able to output ODF files",
long_description="""
aeroolib
=========
A templating library which provides a way to easily output all kind of
different files (odt, ods). Adding support for more filetype is easy:
you just have to create a plugin for this.
aeroolib also provides a report repository allowing you to link python objects
and report together, find reports by mimetypes/name/python objects.
""",
license="GPL License",
version=get_version(),
packages=find_packages(),
install_requires=[
"Genshi >= 0.5",
"lxml >= 2.0"
],
classifiers=[
"Development Status :: 4 - Beta",
"Intended Audience :: Developers",
"License :: OSI Approved :: GNU General Public License (GPL)",
"Operating System :: OS Independent",
"Programming Language :: Python",
"Topic :: Software Development :: Libraries :: Python Modules",
"Topic :: Text Processing",
],
test_suite="nose.collector",
)
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment